Package grpc.gateway.protoc_gen_openapiv2.options

Interface Openapiv2.EnumSchemaOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsExtensions(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.
    String
    getDefault()
    string default = 2;
    com.google.protobuf.ByteString
    getDefaultBytes()
    string default = 2;
    String
    getDescription()
    A short description of the schema.
    com.google.protobuf.ByteString
    getDescriptionBytes()
    A short description of the schema.
    String
    getExample()
    string example = 7;
    com.google.protobuf.ByteString
    getExampleBytes()
    string example = 7;
    Map<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.
    Map<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(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(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.
    Openapiv2.ExternalDocumentation
    getExternalDocs()
    Additional external documentation for this schema.
    Openapiv2.ExternalDocumentationOrBuilder
    getExternalDocsOrBuilder()
    Additional external documentation for this schema.
    boolean
    getReadOnly()
    bool read_only = 5;
    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.
    boolean
    getRequired()
    bool required = 4;
    String
    getTitle()
    The title of the schema.
    com.google.protobuf.ByteString
    getTitleBytes()
    The title of the schema.
    boolean
    hasExternalDocs()
    Additional external documentation for this schema.

    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

    • getDescription

      String getDescription()
       A short description of the schema.
      string description = 1;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       A short description of the schema.
      string description = 1;
      Returns:
      The bytes for description.

    • getDefault

      String getDefault()
      string default = 2;
      Returns:
      The default.

    • getDefaultBytes

      com.google.protobuf.ByteString getDefaultBytes()
      string default = 2;
      Returns:
      The bytes for default.

    • getTitle

      String getTitle()
       The title of the schema.
      string title = 3;
      Returns:
      The title.

    • getTitleBytes

      com.google.protobuf.ByteString getTitleBytes()
       The title of the schema.
      string title = 3;
      Returns:
      The bytes for title.

    • getRequired

      boolean getRequired()
      bool required = 4;
      Returns:
      The required.

    • getReadOnly

      boolean getReadOnly()
      bool read_only = 5;
      Returns:
      The readOnly.

    • hasExternalDocs

      boolean hasExternalDocs()
       Additional external documentation for this schema.
      .grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 6;
      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 = 6;
      Returns:
      The externalDocs.

    • getExternalDocsOrBuilder

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

    • getExample

      String getExample()
      string example = 7;
      Returns:
      The example.

    • getExampleBytes

      com.google.protobuf.ByteString getExampleBytes()
      string example = 7;
      Returns:
      The bytes for example.

    • 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 = 8;
      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 = 8;
      Returns:
      The bytes for ref.

    • 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 = 9;

    • containsExtensions

      boolean containsExtensions(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 = 9;

    • getExtensions

      @Deprecated Map<String,com.google.protobuf.Value> getExtensions()
      Deprecated.
      Use getExtensionsMap() instead.

    • getExtensionsMap

      Map<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 = 9;

    • getExtensionsOrDefault

      com.google.protobuf.Value getExtensionsOrDefault(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 = 9;

    • getExtensionsOrThrow

      com.google.protobuf.Value getExtensionsOrThrow(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 = 9;