Package grpc.gateway.protoc_gen_openapiv2.options

Interface Openapiv2.InfoOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Openapiv2.Info, Openapiv2.Info.Builder
Enclosing class:
Openapiv2
public static interface Openapiv2.InfoOrBuilder 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.
    Openapiv2.Contact
    getContact()
    The contact information for the exposed API.
    Openapiv2.ContactOrBuilder
    getContactOrBuilder()
    The contact information for the exposed API.
    String
    getDescription()
    A short description of the application.
    com.google.protobuf.ByteString
    getDescriptionBytes()
    A short description of the application.
    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.License
    getLicense()
    The license information for the exposed API.
    Openapiv2.LicenseOrBuilder
    getLicenseOrBuilder()
    The license information for the exposed API.
    String
    getTermsOfService()
    The Terms of Service for the API.
    com.google.protobuf.ByteString
    getTermsOfServiceBytes()
    The Terms of Service for the API.
    String
    getTitle()
    The title of the application.
    com.google.protobuf.ByteString
    getTitleBytes()
    The title of the application.
    String
    getVersion()
    Provides the version of the application API (not to be confused with the specification version).
    com.google.protobuf.ByteString
    getVersionBytes()
    Provides the version of the application API (not to be confused with the specification version).
    boolean
    hasContact()
    The contact information for the exposed API.
    boolean
    hasLicense()
    The license information for the exposed API.

    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

    • getTitle

      String getTitle()
       The title of the application.
      string title = 1;
      Returns:
      The title.

    • getTitleBytes

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

    • getDescription

      String getDescription()
       A short description of the application. GFM syntax can be used for rich
 text representation.
      string description = 2;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       A short description of the application. GFM syntax can be used for rich
 text representation.
      string description = 2;
      Returns:
      The bytes for description.

    • getTermsOfService

      String getTermsOfService()
       The Terms of Service for the API.
      string terms_of_service = 3;
      Returns:
      The termsOfService.

    • getTermsOfServiceBytes

      com.google.protobuf.ByteString getTermsOfServiceBytes()
       The Terms of Service for the API.
      string terms_of_service = 3;
      Returns:
      The bytes for termsOfService.

    • hasContact

      boolean hasContact()
       The contact information for the exposed API.
      .grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4;
      Returns:
      Whether the contact field is set.

    • getContact

      Openapiv2.Contact getContact()
       The contact information for the exposed API.
      .grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4;
      Returns:
      The contact.

    • getContactOrBuilder

      Openapiv2.ContactOrBuilder getContactOrBuilder()
       The contact information for the exposed API.
      .grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4;

    • hasLicense

      boolean hasLicense()
       The license information for the exposed API.
      .grpc.gateway.protoc_gen_openapiv2.options.License license = 5;
      Returns:
      Whether the license field is set.

    • getLicense

      Openapiv2.License getLicense()
       The license information for the exposed API.
      .grpc.gateway.protoc_gen_openapiv2.options.License license = 5;
      Returns:
      The license.

    • getLicenseOrBuilder

      Openapiv2.LicenseOrBuilder getLicenseOrBuilder()
       The license information for the exposed API.
      .grpc.gateway.protoc_gen_openapiv2.options.License license = 5;

    • getVersion

      String getVersion()
       Provides the version of the application API (not to be confused
 with the specification version).
      string version = 6;
      Returns:
      The version.

    • getVersionBytes

      com.google.protobuf.ByteString getVersionBytes()
       Provides the version of the application API (not to be confused
 with the specification version).
      string version = 6;
      Returns:
      The bytes for version.

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

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

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

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

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