Constructor Detail

Method Detail

• getRef

   abstract 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

   abstract 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;

• getTitle

   abstract String getTitle()

  The title of the schema.
  

  string title = 5;

• getTitleBytes

   abstract ByteString getTitleBytes()

  The title of the schema.
  

  string title = 5;

• getDescription

   abstract String getDescription()

  A short description of the schema.
  

  string description = 6;

• getDescriptionBytes

   abstract ByteString getDescriptionBytes()

  A short description of the schema.
  

  string description = 6;

• getDefault

   abstract String getDefault()

  string default = 7;

• getDefaultBytes

   abstract ByteString getDefaultBytes()

  string default = 7;

• getReadOnly

   abstract boolean getReadOnly()

  bool read_only = 8;

• getExample

   abstract 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;

• getExampleBytes

   abstract 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;

• getMultipleOf

   abstract double getMultipleOf()

  double multiple_of = 10;

• getMaximum

   abstract double getMaximum()

  Maximum represents an inclusive upper limit for a numeric instance. The
  value of MUST be a number,
  

  double maximum = 11;

• getExclusiveMaximum

   abstract boolean getExclusiveMaximum()

  bool exclusive_maximum = 12;

• getMinimum

   abstract double getMinimum()

  minimum represents an inclusive lower limit for a numeric instance. The
  value of MUST be a number,
  

  double minimum = 13;

• getExclusiveMinimum

   abstract boolean getExclusiveMinimum()

  bool exclusive_minimum = 14;

• getMaxLength

   abstract long getMaxLength()

  uint64 max_length = 15;

• getMinLength

   abstract long getMinLength()

  uint64 min_length = 16;

• getPattern

   abstract String getPattern()

  string pattern = 17;

• getPatternBytes

   abstract ByteString getPatternBytes()

  string pattern = 17;

• getMaxItems

   abstract long getMaxItems()

  uint64 max_items = 20;

• getMinItems

   abstract long getMinItems()

  uint64 min_items = 21;

• getUniqueItems

   abstract boolean getUniqueItems()

  bool unique_items = 22;

• getMaxProperties

   abstract long getMaxProperties()

  uint64 max_properties = 24;

• getMinProperties

   abstract long getMinProperties()

  uint64 min_properties = 25;

• getRequiredList

   abstract List<String> getRequiredList()

  repeated string required = 26;

• getRequiredCount

   abstract int getRequiredCount()

  repeated string required = 26;

• getRequired

   abstract String getRequired(int index)

  repeated string required = 26;

  Parameters:

  index - The index of the element to return.

• getRequiredBytes

   abstract ByteString getRequiredBytes(int index)

  repeated string required = 26;

  Parameters:

  index - The index of the value to return.

• getArrayList

   abstract List<String> getArrayList()

  Items in 'array' must be unique.
  

  repeated string array = 34;

• getArrayCount

   abstract int getArrayCount()

  Items in 'array' must be unique.
  

  repeated string array = 34;

• getArray

   abstract String getArray(int index)

  Items in 'array' must be unique.
  

  repeated string array = 34;

  Parameters:

  index - The index of the element to return.

• getArrayBytes

   abstract ByteString getArrayBytes(int index)

  Items in 'array' must be unique.
  

  repeated string array = 34;

  Parameters:

  index - The index of the value to return.

• getTypeList

   abstract List<Openapiv2.JSONSchema.JSONSchemaSimpleTypes> getTypeList()

  repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;

• getTypeCount

   abstract int getTypeCount()

  repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;

• getType

   abstract 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.

• getTypeValueList

   abstract List<Integer> getTypeValueList()

  repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;

• getTypeValue

   abstract int getTypeValue(int index)

  repeated .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema.JSONSchemaSimpleTypes type = 35;

  Parameters:

  index - The index of the value to return.

• getFormat

   abstract String getFormat()

  `Format`
  

  string format = 36;

• getFormatBytes

   abstract ByteString getFormatBytes()

  `Format`
  

  string format = 36;

• getEnumList

   abstract List<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;

• getEnumCount

   abstract 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;

• getEnum

   abstract String getEnum(int index)

  Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1
  

  repeated string enum = 46;

  Parameters:

  index - The index of the element to return.

• getEnumBytes

   abstract ByteString getEnumBytes(int index)

  Items in `enum` must be unique https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1
  

  repeated string enum = 46;

  Parameters:

  index - The index of the value to return.

• hasFieldConfiguration

   abstract 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

   abstract 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;

• getFieldConfigurationOrBuilder

   abstract 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

   abstract int getExtensionsCount()

  map<string, .google.protobuf.Value> extensions = 48;

• containsExtensions

   abstract boolean containsExtensions(String key)

  map<string, .google.protobuf.Value> extensions = 48;

• getExtensions

  @Deprecated() abstract Map<String, Value> getExtensions()

  Use getExtensionsMap instead.

• getExtensionsMap

   abstract Map<String, Value> getExtensionsMap()

  map<string, .google.protobuf.Value> extensions = 48;

• getExtensionsOrDefault

   abstract Value getExtensionsOrDefault(String key, Value defaultValue)

  map<string, .google.protobuf.Value> extensions = 48;

• getExtensionsOrThrow

   abstract Value getExtensionsOrThrow(String key)

  map<string, .google.protobuf.Value> extensions = 48;