Package grpc.gateway.protoc_gen_swagger.options

Class Openapiv2.Schema

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Openapiv2.SchemaOrBuilder, Serializable
    Enclosing class:
    Openapiv2
    public static final class Openapiv2.Schema
extends com.google.protobuf.GeneratedMessageV3
implements Openapiv2.SchemaOrBuilder
     `Schema` is a representation of OpenAPI v2 specification's Schema object.
 See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject
    Protobuf type grpc.gateway.protoc_gen_swagger.options.Schema
    See Also:
    Serialized Form

    • Constructor Detail

      • Schema

        private Schema​(com.google.protobuf.GeneratedMessageV3.Builder<?> builder)

      • Schema

        private Schema()

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasJsonSchema

        public boolean hasJsonSchema()
        .grpc.gateway.protoc_gen_swagger.options.JSONSchema json_schema = 1;
        Specified by:
        hasJsonSchema in interface Openapiv2.SchemaOrBuilder
        Returns:
        Whether the jsonSchema field is set.

      • getDiscriminator

        public 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;
        Specified by:
        getDiscriminator in interface Openapiv2.SchemaOrBuilder
        Returns:
        The discriminator.

      • getDiscriminatorBytes

        public 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;
        Specified by:
        getDiscriminatorBytes in interface Openapiv2.SchemaOrBuilder
        Returns:
        The bytes for discriminator.

      • getReadOnly

        public 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;
        Specified by:
        getReadOnly in interface Openapiv2.SchemaOrBuilder
        Returns:
        The readOnly.

      • hasExternalDocs

        public boolean hasExternalDocs()
         Additional external documentation for this schema.
        .grpc.gateway.protoc_gen_swagger.options.ExternalDocumentation external_docs = 5;
        Specified by:
        hasExternalDocs in interface Openapiv2.SchemaOrBuilder
        Returns:
        Whether the externalDocs field is set.

      • hasExample

        @Deprecated
public boolean hasExample()
        Deprecated.
        grpc.gateway.protoc_gen_swagger.options.Schema.example is deprecated. See protoc-gen-swagger/options/openapiv2.proto;l=337
         A free-form property to include an example of an instance for this schema.
 Deprecated, please use example_string instead.
        .google.protobuf.Any example = 6 [deprecated = true];
        Specified by:
        hasExample in interface Openapiv2.SchemaOrBuilder
        Returns:
        Whether the example field is set.

      • getExample

        @Deprecated
public com.google.protobuf.Any getExample()
        Deprecated.
        grpc.gateway.protoc_gen_swagger.options.Schema.example is deprecated. See protoc-gen-swagger/options/openapiv2.proto;l=337
         A free-form property to include an example of an instance for this schema.
 Deprecated, please use example_string instead.
        .google.protobuf.Any example = 6 [deprecated = true];
        Specified by:
        getExample in interface Openapiv2.SchemaOrBuilder
        Returns:
        The example.

      • getExampleOrBuilder

        @Deprecated
public com.google.protobuf.AnyOrBuilder getExampleOrBuilder()
        Deprecated.
         A free-form property to include an example of an instance for this schema.
 Deprecated, please use example_string instead.
        .google.protobuf.Any example = 6 [deprecated = true];
        Specified by:
        getExampleOrBuilder in interface Openapiv2.SchemaOrBuilder

      • getExampleString

        public String getExampleString()
         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.
        string example_string = 7;
        Specified by:
        getExampleString in interface Openapiv2.SchemaOrBuilder
        Returns:
        The exampleString.

      • getExampleStringBytes

        public com.google.protobuf.ByteString getExampleStringBytes()
         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.
        string example_string = 7;
        Specified by:
        getExampleStringBytes in interface Openapiv2.SchemaOrBuilder
        Returns:
        The bytes for exampleString.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(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 Openapiv2.Schema parseFrom​(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Openapiv2.Schema parseFrom​(ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Openapiv2.Schema parseFrom​(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Openapiv2.Schema parseFrom​(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Openapiv2.Schema parseFrom​(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Openapiv2.Schema parseFrom​(byte[] data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Openapiv2.Schema parseFrom​(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Openapiv2.Schema.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Openapiv2.Schema.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Openapiv2.Schema.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<Openapiv2.Schema> 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.GeneratedMessageV3

      • getDefaultInstanceForType

        public Openapiv2.Schema getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder