-
- All Implemented Interfaces:
-
com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.JSONSchemaOrBuilder,java.lang.Cloneable
public final class Openapiv2.JSONSchema.Builder extends GeneratedMessageV3.Builder<BuilderType> implements Openapiv2.JSONSchemaOrBuilder
Protobuf type`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." }]; }grpc.gateway.protoc_gen_openapiv2.options.JSONSchema
-
-
Field Summary
Fields Modifier and Type Field Description public UnknownFieldSetunknownFields
-
Method Summary
Modifier and Type Method Description final static Descriptors.DescriptorgetDescriptor()Openapiv2.JSONSchema.Builderclear()Descriptors.DescriptorgetDescriptorForType()Openapiv2.JSONSchemagetDefaultInstanceForType()Openapiv2.JSONSchemabuild()Openapiv2.JSONSchemabuildPartial()Openapiv2.JSONSchema.Builderclone()Openapiv2.JSONSchema.BuildersetField(Descriptors.FieldDescriptor field, Object value)Openapiv2.JSONSchema.BuilderclearField(Descriptors.FieldDescriptor field)Openapiv2.JSONSchema.BuilderclearOneof(Descriptors.OneofDescriptor oneof)Openapiv2.JSONSchema.BuildersetRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)Openapiv2.JSONSchema.BuilderaddRepeatedField(Descriptors.FieldDescriptor field, Object value)Openapiv2.JSONSchema.BuildermergeFrom(Message other)Openapiv2.JSONSchema.BuildermergeFrom(Openapiv2.JSONSchema other)final booleanisInitialized()Openapiv2.JSONSchema.BuildermergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)StringgetRef()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;ByteStringgetRefBytes()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;Openapiv2.JSONSchema.BuildersetRef(String value)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;Openapiv2.JSONSchema.BuilderclearRef()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;Openapiv2.JSONSchema.BuildersetRefBytes(ByteString value)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;StringgetTitle()The title of the schema.string title = 5;ByteStringgetTitleBytes()The title of the schema.string title = 5;Openapiv2.JSONSchema.BuildersetTitle(String value)The title of the schema.string title = 5;Openapiv2.JSONSchema.BuilderclearTitle()The title of the schema.string title = 5;Openapiv2.JSONSchema.BuildersetTitleBytes(ByteString value)The title of the schema.string title = 5;StringgetDescription()A short description of the schema.string description = 6;ByteStringgetDescriptionBytes()A short description of the schema.string description = 6;Openapiv2.JSONSchema.BuildersetDescription(String value)A short description of the schema.string description = 6;Openapiv2.JSONSchema.BuilderclearDescription()A short description of the schema.string description = 6;Openapiv2.JSONSchema.BuildersetDescriptionBytes(ByteString value)A short description of the schema.string description = 6;StringgetDefault()string default = 7;ByteStringgetDefaultBytes()string default = 7;Openapiv2.JSONSchema.BuildersetDefault(String value)string default = 7;Openapiv2.JSONSchema.BuilderclearDefault()string default = 7;Openapiv2.JSONSchema.BuildersetDefaultBytes(ByteString value)string default = 7;booleangetReadOnly()bool read_only = 8;Openapiv2.JSONSchema.BuildersetReadOnly(boolean value)bool read_only = 8;Openapiv2.JSONSchema.BuilderclearReadOnly()bool read_only = 8;StringgetExample()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#schemaObjectstring example = 9;ByteStringgetExampleBytes()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#schemaObjectstring example = 9;Openapiv2.JSONSchema.BuildersetExample(String value)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#schemaObjectstring example = 9;Openapiv2.JSONSchema.BuilderclearExample()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#schemaObjectstring example = 9;Openapiv2.JSONSchema.BuildersetExampleBytes(ByteString value)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#schemaObjectstring example = 9;doublegetMultipleOf()double multiple_of = 10;Openapiv2.JSONSchema.BuildersetMultipleOf(double value)double multiple_of = 10;Openapiv2.JSONSchema.BuilderclearMultipleOf()double multiple_of = 10;doublegetMaximum()Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number,double maximum = 11;Openapiv2.JSONSchema.BuildersetMaximum(double value)Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number,double maximum = 11;Openapiv2.JSONSchema.BuilderclearMaximum()Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number,double maximum = 11;booleangetExclusiveMaximum()bool exclusive_maximum = 12;Openapiv2.JSONSchema.BuildersetExclusiveMaximum(boolean value)bool exclusive_maximum = 12;Openapiv2.JSONSchema.BuilderclearExclusiveMaximum()bool exclusive_maximum = 12;doublegetMinimum()minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number,double minimum = 13;Openapiv2.JSONSchema.BuildersetMinimum(double value)minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number,double minimum = 13;Openapiv2.JSONSchema.BuilderclearMinimum()minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number,double minimum = 13;booleangetExclusiveMinimum()bool exclusive_minimum = 14;Openapiv2.JSONSchema.BuildersetExclusiveMinimum(boolean value)bool exclusive_minimum = 14;Openapiv2.JSONSchema.BuilderclearExclusiveMinimum()bool exclusive_minimum = 14;longgetMaxLength()uint64 max_length = 15;Openapiv2.JSONSchema.BuildersetMaxLength(long value)uint64 max_length = 15;Openapiv2.JSONSchema.BuilderclearMaxLength()uint64 max_length = 15;longgetMinLength()uint64 min_length = 16;Openapiv2.JSONSchema.BuildersetMinLength(long value)uint64 min_length = 16;Openapiv2.JSONSchema.BuilderclearMinLength()uint64 min_length = 16;StringgetPattern()string pattern = 17;ByteStringgetPatternBytes()string pattern = 17;Openapiv2.JSONSchema.BuildersetPattern(String value)string pattern = 17;Openapiv2.JSONSchema.BuilderclearPattern()string pattern = 17;Openapiv2.JSONSchema.BuildersetPatternBytes(ByteString value)string pattern = 17;longgetMaxItems()uint64 max_items = 20;Openapiv2.JSONSchema.BuildersetMaxItems(long value)uint64 max_items = 20;Openapiv2.JSONSchema.BuilderclearMaxItems()uint64 max_items = 20;longgetMinItems()uint64 min_items = 21;Openapiv2.JSONSchema.BuildersetMinItems(long value)uint64 min_items = 21;Openapiv2.JSONSchema.BuilderclearMinItems()uint64 min_items = 21;booleangetUniqueItems()bool unique_items = 22;Openapiv2.JSONSchema.BuildersetUniqueItems(boolean value)bool unique_items = 22;Openapiv2.JSONSchema.BuilderclearUniqueItems()bool unique_items = 22;longgetMaxProperties()uint64 max_properties = 24;Openapiv2.JSONSchema.BuildersetMaxProperties(long value)uint64 max_properties = 24;Openapiv2.JSONSchema.BuilderclearMaxProperties()uint64 max_properties = 24;longgetMinProperties()uint64 min_properties = 25;Openapiv2.JSONSchema.BuildersetMinProperties(long value)uint64 min_properties = 25;Openapiv2.JSONSchema.BuilderclearMinProperties()uint64 min_properties = 25;ProtocolStringListgetRequiredList()repeated string required = 26;intgetRequiredCount()repeated string required = 26;StringgetRequired(int index)repeated string required = 26;ByteStringgetRequiredBytes(int index)repeated string required = 26;Openapiv2.JSONSchema.BuildersetRequired(int index, String value)repeated string required = 26;Openapiv2.JSONSchema.BuilderaddRequired(String value)repeated string required = 26;Openapiv2.JSONSchema.BuilderaddAllRequired(Iterable<String> values)repeated string required = 26;Openapiv2.JSONSchema.BuilderclearRequired()repeated string required = 26;Openapiv2.JSONSchema.BuilderaddRequiredBytes(ByteString value)repeated string required = 26;ProtocolStringListgetArrayList()Items in 'array' must be unique.repeated string array = 34;intgetArrayCount()Items in 'array' must be unique.repeated string array = 34;StringgetArray(int index)Items in 'array' must be unique.repeated string array = 34;ByteStringgetArrayBytes(int index)Items in 'array' must be unique.repeated string array = 34;Openapiv2.JSONSchema.BuildersetArray(int index, String value)Items in 'array' must be unique.repeated string array = 34;Openapiv2.JSONSchema.BuilderaddArray(String value)Items in 'array' must be unique.repeated string array = 34;Openapiv2.JSONSchema.BuilderaddAllArray(Iterable<String> values)Items in 'array' must be unique.repeated string array = 34;Openapiv2.JSONSchema.BuilderclearArray()Items in 'array' must be unique.repeated string array = 34;Openapiv2.JSONSchema.BuilderaddArrayBytes(ByteString value)Items in 'array' must be unique.repeated string array = 34;List<Openapiv2.JSONSchema.JSONSchemaSimpleTypes>getTypeList()repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;intgetTypeCount()repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;Openapiv2.JSONSchema.JSONSchemaSimpleTypesgetType(int index)repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;Openapiv2.JSONSchema.BuildersetType(int index, Openapiv2.JSONSchema.JSONSchemaSimpleTypes value)repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;Openapiv2.JSONSchema.BuilderaddType(Openapiv2.JSONSchema.JSONSchemaSimpleTypes value)repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;Openapiv2.JSONSchema.BuilderaddAllType(Iterable<out Openapiv2.JSONSchema.JSONSchemaSimpleTypes> values)repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;Openapiv2.JSONSchema.BuilderclearType()repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;List<Integer>getTypeValueList()repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;intgetTypeValue(int index)repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;Openapiv2.JSONSchema.BuildersetTypeValue(int index, int value)repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;Openapiv2.JSONSchema.BuilderaddTypeValue(int value)repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;Openapiv2.JSONSchema.BuilderaddAllTypeValue(Iterable<Integer> values)repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;StringgetFormat()`Format`string format = 36;ByteStringgetFormatBytes()`Format`string format = 36;Openapiv2.JSONSchema.BuildersetFormat(String value)`Format`string format = 36;Openapiv2.JSONSchema.BuilderclearFormat()`Format`string format = 36;Openapiv2.JSONSchema.BuildersetFormatBytes(ByteString value)`Format`string format = 36;ProtocolStringListgetEnumList()Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1repeated string enum = 46;intgetEnumCount()Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1repeated string enum = 46;StringgetEnum(int index)Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1repeated string enum = 46;ByteStringgetEnumBytes(int index)Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1repeated string enum = 46;Openapiv2.JSONSchema.BuildersetEnum(int index, String value)Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1repeated string enum = 46;Openapiv2.JSONSchema.BuilderaddEnum(String value)Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1repeated string enum = 46;Openapiv2.JSONSchema.BuilderaddAllEnum(Iterable<String> values)Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1repeated string enum = 46;Openapiv2.JSONSchema.BuilderclearEnum()Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1repeated string enum = 46;Openapiv2.JSONSchema.BuilderaddEnumBytes(ByteString value)Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1repeated string enum = 46;booleanhasFieldConfiguration()Additional field level properties used when generating the OpenAPI v2 file..grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.FieldConfiguration field_configuration = 1001;Openapiv2.JSONSchema.FieldConfigurationgetFieldConfiguration()Additional field level properties used when generating the OpenAPI v2 file..grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.FieldConfiguration field_configuration = 1001;Openapiv2.JSONSchema.BuildersetFieldConfiguration(Openapiv2.JSONSchema.FieldConfiguration value)Additional field level properties used when generating the OpenAPI v2 file..grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.FieldConfiguration field_configuration = 1001;Openapiv2.JSONSchema.BuildersetFieldConfiguration(Openapiv2.JSONSchema.FieldConfiguration.Builder builderForValue)Additional field level properties used when generating the OpenAPI v2 file..grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.FieldConfiguration field_configuration = 1001;Openapiv2.JSONSchema.BuildermergeFieldConfiguration(Openapiv2.JSONSchema.FieldConfiguration value)Additional field level properties used when generating the OpenAPI v2 file..grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.FieldConfiguration field_configuration = 1001;Openapiv2.JSONSchema.BuilderclearFieldConfiguration()Additional field level properties used when generating the OpenAPI v2 file..grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.FieldConfiguration field_configuration = 1001;Openapiv2.JSONSchema.FieldConfiguration.BuildergetFieldConfigurationBuilder()Additional field level properties used when generating the OpenAPI v2 file..grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.FieldConfiguration field_configuration = 1001;Openapiv2.JSONSchema.FieldConfigurationOrBuildergetFieldConfigurationOrBuilder()Additional field level properties used when generating the OpenAPI v2 file..grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.FieldConfiguration field_configuration = 1001;intgetExtensionsCount()map<string, .google.protobuf.Value> extensions = 48;booleancontainsExtensions(String key)map<string, .google.protobuf.Value> extensions = 48;Map<String, Value>getExtensions()Use getExtensionsMap instead. Map<String, Value>getExtensionsMap()map<string, .google.protobuf.Value> extensions = 48;ValuegetExtensionsOrDefault(String key, Value defaultValue)map<string, .google.protobuf.Value> extensions = 48;ValuegetExtensionsOrThrow(String key)map<string, .google.protobuf.Value> extensions = 48;Openapiv2.JSONSchema.BuilderclearExtensions()Openapiv2.JSONSchema.BuilderremoveExtensions(String key)map<string, .google.protobuf.Value> extensions = 48;Map<String, Value>getMutableExtensions()Use alternate mutation accessors instead. Openapiv2.JSONSchema.BuilderputExtensions(String key, Value value)map<string, .google.protobuf.Value> extensions = 48;Openapiv2.JSONSchema.BuilderputAllExtensions(Map<String, Value> values)map<string, .google.protobuf.Value> extensions = 48;final Openapiv2.JSONSchema.BuildersetUnknownFields(UnknownFieldSet unknownFields)final Openapiv2.JSONSchema.BuildermergeUnknownFields(UnknownFieldSet unknownFields)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, newBuilderForField, setUnknownFields -
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, toString -
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
mergeDelimitedFrom -
Methods inherited from class com.google.protobuf.Message.Builder
addRepeatedField, clear, clearField, clearOneof, clone, mergeFrom, mergeUnknownFields, setField, setRepeatedField -
Methods inherited from class com.google.protobuf.MessageLite.Builder
build, buildPartial -
Methods inherited from class com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
getDescriptor
final static Descriptors.Descriptor getDescriptor()
-
clear
Openapiv2.JSONSchema.Builder clear()
-
getDescriptorForType
Descriptors.Descriptor getDescriptorForType()
-
getDefaultInstanceForType
Openapiv2.JSONSchema getDefaultInstanceForType()
-
build
Openapiv2.JSONSchema build()
-
buildPartial
Openapiv2.JSONSchema buildPartial()
-
clone
Openapiv2.JSONSchema.Builder clone()
-
setField
Openapiv2.JSONSchema.Builder setField(Descriptors.FieldDescriptor field, Object value)
-
clearField
Openapiv2.JSONSchema.Builder clearField(Descriptors.FieldDescriptor field)
-
clearOneof
Openapiv2.JSONSchema.Builder clearOneof(Descriptors.OneofDescriptor oneof)
-
setRepeatedField
Openapiv2.JSONSchema.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
-
addRepeatedField
Openapiv2.JSONSchema.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
-
mergeFrom
Openapiv2.JSONSchema.Builder mergeFrom(Message other)
-
mergeFrom
Openapiv2.JSONSchema.Builder mergeFrom(Openapiv2.JSONSchema other)
-
isInitialized
final boolean isInitialized()
-
mergeFrom
Openapiv2.JSONSchema.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
-
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;
-
getRefBytes
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;
-
setRef
Openapiv2.JSONSchema.Builder setRef(String value)
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;- Parameters:
value- The ref to set.
-
clearRef
Openapiv2.JSONSchema.Builder clearRef()
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;
-
setRefBytes
Openapiv2.JSONSchema.Builder setRefBytes(ByteString value)
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;- Parameters:
value- The bytes for ref to set.
-
getTitle
String getTitle()
The title of the schema.string title = 5;
-
getTitleBytes
ByteString getTitleBytes()
The title of the schema.string title = 5;
-
setTitle
Openapiv2.JSONSchema.Builder setTitle(String value)
The title of the schema.string title = 5;- Parameters:
value- The title to set.
-
clearTitle
Openapiv2.JSONSchema.Builder clearTitle()
The title of the schema.string title = 5;
-
setTitleBytes
Openapiv2.JSONSchema.Builder setTitleBytes(ByteString value)
The title of the schema.string title = 5;- Parameters:
value- The bytes for title to set.
-
getDescription
String getDescription()
A short description of the schema.string description = 6;
-
getDescriptionBytes
ByteString getDescriptionBytes()
A short description of the schema.string description = 6;
-
setDescription
Openapiv2.JSONSchema.Builder setDescription(String value)
A short description of the schema.string description = 6;- Parameters:
value- The description to set.
-
clearDescription
Openapiv2.JSONSchema.Builder clearDescription()
A short description of the schema.string description = 6;
-
setDescriptionBytes
Openapiv2.JSONSchema.Builder setDescriptionBytes(ByteString value)
A short description of the schema.string description = 6;- Parameters:
value- The bytes for description to set.
-
getDefault
String getDefault()
string default = 7;
-
getDefaultBytes
ByteString getDefaultBytes()
string default = 7;
-
setDefault
Openapiv2.JSONSchema.Builder setDefault(String value)
string default = 7;- Parameters:
value- The default to set.
-
clearDefault
Openapiv2.JSONSchema.Builder clearDefault()
string default = 7;
-
setDefaultBytes
Openapiv2.JSONSchema.Builder setDefaultBytes(ByteString value)
string default = 7;- Parameters:
value- The bytes for default to set.
-
getReadOnly
boolean getReadOnly()
bool read_only = 8;
-
setReadOnly
Openapiv2.JSONSchema.Builder setReadOnly(boolean value)
bool read_only = 8;- Parameters:
value- The readOnly to set.
-
clearReadOnly
Openapiv2.JSONSchema.Builder clearReadOnly()
bool read_only = 8;
-
getExample
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#schemaObjectstring example = 9;
-
getExampleBytes
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#schemaObjectstring example = 9;
-
setExample
Openapiv2.JSONSchema.Builder setExample(String value)
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#schemaObjectstring example = 9;- Parameters:
value- The example to set.
-
clearExample
Openapiv2.JSONSchema.Builder clearExample()
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#schemaObjectstring example = 9;
-
setExampleBytes
Openapiv2.JSONSchema.Builder setExampleBytes(ByteString value)
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#schemaObjectstring example = 9;- Parameters:
value- The bytes for example to set.
-
getMultipleOf
double getMultipleOf()
double multiple_of = 10;
-
setMultipleOf
Openapiv2.JSONSchema.Builder setMultipleOf(double value)
double multiple_of = 10;- Parameters:
value- The multipleOf to set.
-
clearMultipleOf
Openapiv2.JSONSchema.Builder clearMultipleOf()
double multiple_of = 10;
-
getMaximum
double getMaximum()
Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number,double maximum = 11;
-
setMaximum
Openapiv2.JSONSchema.Builder setMaximum(double value)
Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number,double maximum = 11;- Parameters:
value- The maximum to set.
-
clearMaximum
Openapiv2.JSONSchema.Builder clearMaximum()
Maximum represents an inclusive upper limit for a numeric instance. The value of MUST be a number,double maximum = 11;
-
getExclusiveMaximum
boolean getExclusiveMaximum()
bool exclusive_maximum = 12;
-
setExclusiveMaximum
Openapiv2.JSONSchema.Builder setExclusiveMaximum(boolean value)
bool exclusive_maximum = 12;- Parameters:
value- The exclusiveMaximum to set.
-
clearExclusiveMaximum
Openapiv2.JSONSchema.Builder clearExclusiveMaximum()
bool exclusive_maximum = 12;
-
getMinimum
double getMinimum()
minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number,double minimum = 13;
-
setMinimum
Openapiv2.JSONSchema.Builder setMinimum(double value)
minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number,double minimum = 13;- Parameters:
value- The minimum to set.
-
clearMinimum
Openapiv2.JSONSchema.Builder clearMinimum()
minimum represents an inclusive lower limit for a numeric instance. The value of MUST be a number,double minimum = 13;
-
getExclusiveMinimum
boolean getExclusiveMinimum()
bool exclusive_minimum = 14;
-
setExclusiveMinimum
Openapiv2.JSONSchema.Builder setExclusiveMinimum(boolean value)
bool exclusive_minimum = 14;- Parameters:
value- The exclusiveMinimum to set.
-
clearExclusiveMinimum
Openapiv2.JSONSchema.Builder clearExclusiveMinimum()
bool exclusive_minimum = 14;
-
getMaxLength
long getMaxLength()
uint64 max_length = 15;
-
setMaxLength
Openapiv2.JSONSchema.Builder setMaxLength(long value)
uint64 max_length = 15;- Parameters:
value- The maxLength to set.
-
clearMaxLength
Openapiv2.JSONSchema.Builder clearMaxLength()
uint64 max_length = 15;
-
getMinLength
long getMinLength()
uint64 min_length = 16;
-
setMinLength
Openapiv2.JSONSchema.Builder setMinLength(long value)
uint64 min_length = 16;- Parameters:
value- The minLength to set.
-
clearMinLength
Openapiv2.JSONSchema.Builder clearMinLength()
uint64 min_length = 16;
-
getPattern
String getPattern()
string pattern = 17;
-
getPatternBytes
ByteString getPatternBytes()
string pattern = 17;
-
setPattern
Openapiv2.JSONSchema.Builder setPattern(String value)
string pattern = 17;- Parameters:
value- The pattern to set.
-
clearPattern
Openapiv2.JSONSchema.Builder clearPattern()
string pattern = 17;
-
setPatternBytes
Openapiv2.JSONSchema.Builder setPatternBytes(ByteString value)
string pattern = 17;- Parameters:
value- The bytes for pattern to set.
-
getMaxItems
long getMaxItems()
uint64 max_items = 20;
-
setMaxItems
Openapiv2.JSONSchema.Builder setMaxItems(long value)
uint64 max_items = 20;- Parameters:
value- The maxItems to set.
-
clearMaxItems
Openapiv2.JSONSchema.Builder clearMaxItems()
uint64 max_items = 20;
-
getMinItems
long getMinItems()
uint64 min_items = 21;
-
setMinItems
Openapiv2.JSONSchema.Builder setMinItems(long value)
uint64 min_items = 21;- Parameters:
value- The minItems to set.
-
clearMinItems
Openapiv2.JSONSchema.Builder clearMinItems()
uint64 min_items = 21;
-
getUniqueItems
boolean getUniqueItems()
bool unique_items = 22;
-
setUniqueItems
Openapiv2.JSONSchema.Builder setUniqueItems(boolean value)
bool unique_items = 22;- Parameters:
value- The uniqueItems to set.
-
clearUniqueItems
Openapiv2.JSONSchema.Builder clearUniqueItems()
bool unique_items = 22;
-
getMaxProperties
long getMaxProperties()
uint64 max_properties = 24;
-
setMaxProperties
Openapiv2.JSONSchema.Builder setMaxProperties(long value)
uint64 max_properties = 24;- Parameters:
value- The maxProperties to set.
-
clearMaxProperties
Openapiv2.JSONSchema.Builder clearMaxProperties()
uint64 max_properties = 24;
-
getMinProperties
long getMinProperties()
uint64 min_properties = 25;
-
setMinProperties
Openapiv2.JSONSchema.Builder setMinProperties(long value)
uint64 min_properties = 25;- Parameters:
value- The minProperties to set.
-
clearMinProperties
Openapiv2.JSONSchema.Builder clearMinProperties()
uint64 min_properties = 25;
-
getRequiredList
ProtocolStringList getRequiredList()
repeated string required = 26;
-
getRequiredCount
int getRequiredCount()
repeated string required = 26;
-
getRequired
String getRequired(int index)
repeated string required = 26;- Parameters:
index- The index of the element to return.
-
getRequiredBytes
ByteString getRequiredBytes(int index)
repeated string required = 26;- Parameters:
index- The index of the value to return.
-
setRequired
Openapiv2.JSONSchema.Builder setRequired(int index, String value)
repeated string required = 26;- Parameters:
index- The index to set the value at.value- The required to set.
-
addRequired
Openapiv2.JSONSchema.Builder addRequired(String value)
repeated string required = 26;- Parameters:
value- The required to add.
-
addAllRequired
Openapiv2.JSONSchema.Builder addAllRequired(Iterable<String> values)
repeated string required = 26;- Parameters:
values- The required to add.
-
clearRequired
Openapiv2.JSONSchema.Builder clearRequired()
repeated string required = 26;
-
addRequiredBytes
Openapiv2.JSONSchema.Builder addRequiredBytes(ByteString value)
repeated string required = 26;- Parameters:
value- The bytes of the required to add.
-
getArrayList
ProtocolStringList getArrayList()
Items in 'array' must be unique.repeated string array = 34;
-
getArrayCount
int getArrayCount()
Items in 'array' must be unique.repeated string array = 34;
-
getArray
String getArray(int index)
Items in 'array' must be unique.repeated string array = 34;- Parameters:
index- The index of the element to return.
-
getArrayBytes
ByteString getArrayBytes(int index)
Items in 'array' must be unique.repeated string array = 34;- Parameters:
index- The index of the value to return.
-
setArray
Openapiv2.JSONSchema.Builder setArray(int index, String value)
Items in 'array' must be unique.repeated string array = 34;- Parameters:
index- The index to set the value at.value- The array to set.
-
addArray
Openapiv2.JSONSchema.Builder addArray(String value)
Items in 'array' must be unique.repeated string array = 34;- Parameters:
value- The array to add.
-
addAllArray
Openapiv2.JSONSchema.Builder addAllArray(Iterable<String> values)
Items in 'array' must be unique.repeated string array = 34;- Parameters:
values- The array to add.
-
clearArray
Openapiv2.JSONSchema.Builder clearArray()
Items in 'array' must be unique.repeated string array = 34;
-
addArrayBytes
Openapiv2.JSONSchema.Builder addArrayBytes(ByteString value)
Items in 'array' must be unique.repeated string array = 34;- Parameters:
value- The bytes of the array to add.
-
getTypeList
List<Openapiv2.JSONSchema.JSONSchemaSimpleTypes> getTypeList()
repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;
-
getTypeCount
int getTypeCount()
repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;
-
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.
-
setType
Openapiv2.JSONSchema.Builder setType(int index, Openapiv2.JSONSchema.JSONSchemaSimpleTypes value)
repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;- Parameters:
index- The index to set the value at.value- The type to set.
-
addType
Openapiv2.JSONSchema.Builder addType(Openapiv2.JSONSchema.JSONSchemaSimpleTypes value)
repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;- Parameters:
value- The type to add.
-
addAllType
Openapiv2.JSONSchema.Builder addAllType(Iterable<out Openapiv2.JSONSchema.JSONSchemaSimpleTypes> values)
repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;- Parameters:
values- The type to add.
-
clearType
Openapiv2.JSONSchema.Builder clearType()
repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;
-
getTypeValueList
List<Integer> getTypeValueList()
repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;
-
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.
-
setTypeValue
Openapiv2.JSONSchema.Builder setTypeValue(int index, int value)
repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;- Parameters:
index- The index to set the value at.value- The enum numeric value on the wire for type to set.
-
addTypeValue
Openapiv2.JSONSchema.Builder addTypeValue(int value)
repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;- Parameters:
value- The enum numeric value on the wire for type to add.
-
addAllTypeValue
Openapiv2.JSONSchema.Builder addAllTypeValue(Iterable<Integer> values)
repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;- Parameters:
values- The enum numeric values on the wire for type to add.
-
getFormat
String getFormat()
`Format`string format = 36;
-
getFormatBytes
ByteString getFormatBytes()
`Format`string format = 36;
-
setFormat
Openapiv2.JSONSchema.Builder setFormat(String value)
`Format`string format = 36;- Parameters:
value- The format to set.
-
clearFormat
Openapiv2.JSONSchema.Builder clearFormat()
`Format`string format = 36;
-
setFormatBytes
Openapiv2.JSONSchema.Builder setFormatBytes(ByteString value)
`Format`string format = 36;- Parameters:
value- The bytes for format to set.
-
getEnumList
ProtocolStringList getEnumList()
Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1repeated string enum = 46;
-
getEnumCount
int getEnumCount()
Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1repeated string enum = 46;
-
getEnum
String getEnum(int index)
Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1repeated string enum = 46;- Parameters:
index- The index of the element to return.
-
getEnumBytes
ByteString getEnumBytes(int index)
Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1repeated string enum = 46;- Parameters:
index- The index of the value to return.
-
setEnum
Openapiv2.JSONSchema.Builder setEnum(int index, String value)
Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1repeated string enum = 46;- Parameters:
index- The index to set the value at.value- The enum to set.
-
addEnum
Openapiv2.JSONSchema.Builder addEnum(String value)
Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1repeated string enum = 46;- Parameters:
value- The enum to add.
-
addAllEnum
Openapiv2.JSONSchema.Builder addAllEnum(Iterable<String> values)
Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1repeated string enum = 46;- Parameters:
values- The enum to add.
-
clearEnum
Openapiv2.JSONSchema.Builder clearEnum()
Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1repeated string enum = 46;
-
addEnumBytes
Openapiv2.JSONSchema.Builder addEnumBytes(ByteString value)
Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1repeated string enum = 46;- Parameters:
value- The bytes of the enum to add.
-
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;
-
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;
-
setFieldConfiguration
Openapiv2.JSONSchema.Builder setFieldConfiguration(Openapiv2.JSONSchema.FieldConfiguration value)
Additional field level properties used when generating the OpenAPI v2 file..grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.FieldConfiguration field_configuration = 1001;
-
setFieldConfiguration
Openapiv2.JSONSchema.Builder setFieldConfiguration(Openapiv2.JSONSchema.FieldConfiguration.Builder builderForValue)
Additional field level properties used when generating the OpenAPI v2 file..grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.FieldConfiguration field_configuration = 1001;
-
mergeFieldConfiguration
Openapiv2.JSONSchema.Builder mergeFieldConfiguration(Openapiv2.JSONSchema.FieldConfiguration value)
Additional field level properties used when generating the OpenAPI v2 file..grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.FieldConfiguration field_configuration = 1001;
-
clearFieldConfiguration
Openapiv2.JSONSchema.Builder clearFieldConfiguration()
Additional field level properties used when generating the OpenAPI v2 file..grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.FieldConfiguration field_configuration = 1001;
-
getFieldConfigurationBuilder
Openapiv2.JSONSchema.FieldConfiguration.Builder getFieldConfigurationBuilder()
Additional field level properties used when generating the OpenAPI v2 file..grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.FieldConfiguration field_configuration = 1001;
-
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()
map<string, .google.protobuf.Value> extensions = 48;
-
containsExtensions
boolean containsExtensions(String key)
map<string, .google.protobuf.Value> extensions = 48;
-
getExtensions
@Deprecated() Map<String, Value> getExtensions()
Use getExtensionsMap instead.
-
getExtensionsMap
Map<String, Value> getExtensionsMap()
map<string, .google.protobuf.Value> extensions = 48;
-
getExtensionsOrDefault
Value getExtensionsOrDefault(String key, Value defaultValue)
map<string, .google.protobuf.Value> extensions = 48;
-
getExtensionsOrThrow
Value getExtensionsOrThrow(String key)
map<string, .google.protobuf.Value> extensions = 48;
-
clearExtensions
Openapiv2.JSONSchema.Builder clearExtensions()
-
removeExtensions
Openapiv2.JSONSchema.Builder removeExtensions(String key)
map<string, .google.protobuf.Value> extensions = 48;
-
getMutableExtensions
@Deprecated() Map<String, Value> getMutableExtensions()
Use alternate mutation accessors instead.
-
putExtensions
Openapiv2.JSONSchema.Builder putExtensions(String key, Value value)
map<string, .google.protobuf.Value> extensions = 48;
-
putAllExtensions
Openapiv2.JSONSchema.Builder putAllExtensions(Map<String, Value> values)
map<string, .google.protobuf.Value> extensions = 48;
-
setUnknownFields
final Openapiv2.JSONSchema.Builder setUnknownFields(UnknownFieldSet unknownFields)
-
mergeUnknownFields
final Openapiv2.JSONSchema.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
-
-
-
-