Package grpc.gateway.protoc_gen_openapiv2.options

Interface Openapiv2.SchemaOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Openapiv2.Schema, Openapiv2.Schema.Builder
Enclosing class:
Openapiv2
public static interface Openapiv2.SchemaOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDiscriminator()
    Adds support for polymorphism.
    com.google.protobuf.ByteString
    getDiscriminatorBytes()
    Adds support for polymorphism.
    String
    getExample()
    A free-form property to include an example of an instance for this schema in JSON.
    com.google.protobuf.ByteString
    getExampleBytes()
    A free-form property to include an example of an instance for this schema in JSON.
    Openapiv2.ExternalDocumentation
    getExternalDocs()
    Additional external documentation for this schema.
    Openapiv2.ExternalDocumentationOrBuilder
    getExternalDocsOrBuilder()
    Additional external documentation for this schema.
    Openapiv2.JSONSchema
    getJsonSchema()
    .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1;
    Openapiv2.JSONSchemaOrBuilder
    getJsonSchemaOrBuilder()
    .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1;
    boolean
    getReadOnly()
    Relevant only for Schema "properties" definitions.
    boolean
    hasExternalDocs()
    Additional external documentation for this schema.
    boolean
    hasJsonSchema()
    .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1;

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • hasJsonSchema

      boolean hasJsonSchema()
      .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1;
      Returns:
      Whether the jsonSchema field is set.

    • getJsonSchema

      Openapiv2.JSONSchema getJsonSchema()
      .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1;
      Returns:
      The jsonSchema.

    • getJsonSchemaOrBuilder

      Openapiv2.JSONSchemaOrBuilder getJsonSchemaOrBuilder()
      .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1;

    • getDiscriminator

      String getDiscriminator()
       Adds support for polymorphism. The discriminator is the schema property
 name that is used to differentiate between other schema that inherit this
 schema. The property name used MUST be defined at this schema and it MUST
 be in the required property list. When used, the value MUST be the name of
 this schema or any schema that inherits it.
      string discriminator = 2;
      Returns:
      The discriminator.

    • getDiscriminatorBytes

      com.google.protobuf.ByteString getDiscriminatorBytes()
       Adds support for polymorphism. The discriminator is the schema property
 name that is used to differentiate between other schema that inherit this
 schema. The property name used MUST be defined at this schema and it MUST
 be in the required property list. When used, the value MUST be the name of
 this schema or any schema that inherits it.
      string discriminator = 2;
      Returns:
      The bytes for discriminator.

    • getReadOnly

      boolean getReadOnly()
       Relevant only for Schema "properties" definitions. Declares the property as
 "read only". This means that it MAY be sent as part of a response but MUST
 NOT be sent as part of the request. Properties marked as readOnly being
 true SHOULD NOT be in the required list of the defined schema. Default
 value is false.
      bool read_only = 3;
      Returns:
      The readOnly.

    • hasExternalDocs

      boolean hasExternalDocs()
       Additional external documentation for this schema.
      .grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 5;
      Returns:
      Whether the externalDocs field is set.

    • getExternalDocs

      Openapiv2.ExternalDocumentation getExternalDocs()
       Additional external documentation for this schema.
      .grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 5;
      Returns:
      The externalDocs.

    • getExternalDocsOrBuilder

      Openapiv2.ExternalDocumentationOrBuilder getExternalDocsOrBuilder()
       Additional external documentation for this schema.
      .grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 5;

    • getExample

      String getExample()
       A free-form property to include an example of an instance for this schema in JSON.
 This is copied verbatim to the output.
      string example = 6;
      Returns:
      The example.

    • getExampleBytes

      com.google.protobuf.ByteString getExampleBytes()
       A free-form property to include an example of an instance for this schema in JSON.
 This is copied verbatim to the output.
      string example = 6;
      Returns:
      The bytes for example.