Package grpc.gateway.protoc_gen_openapiv2.options

Class Openapiv2.ExternalDocumentation.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Openapiv2.ExternalDocumentationOrBuilder, java.lang.Cloneable
    Enclosing class:
    Openapiv2.ExternalDocumentation
    public static final class Openapiv2.ExternalDocumentation.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.ExternalDocumentation.Builder>
implements Openapiv2.ExternalDocumentationOrBuilder
     `ExternalDocumentation` is a representation of OpenAPI v2 specification's
 ExternalDocumentation object.

 See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#externalDocumentationObject

 Example:

  option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
    ...
    external_docs: {
      description: "More about gRPC-Gateway";
      url: "https://github.com/grpc-ecosystem/grpc-gateway";
    }
    ...
  };
    Protobuf type grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation

    • Method Detail

      • 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.Builder<Openapiv2.ExternalDocumentation.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.ExternalDocumentation.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.ExternalDocumentation.Builder>

      • mergeFrom

        public Openapiv2.ExternalDocumentation.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Openapiv2.ExternalDocumentation.Builder>
        Throws:
        java.io.IOException

      • getDescription

        public java.lang.String getDescription()
         A short description of the target documentation. GFM syntax can be used for
 rich text representation.
        string description = 1;
        Specified by:
        getDescription in interface Openapiv2.ExternalDocumentationOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         A short description of the target documentation. GFM syntax can be used for
 rich text representation.
        string description = 1;
        Specified by:
        getDescriptionBytes in interface Openapiv2.ExternalDocumentationOrBuilder
        Returns:
        The bytes for description.

      • setDescription

        public Openapiv2.ExternalDocumentation.Builder setDescription​(java.lang.String value)
         A short description of the target documentation. GFM syntax can be used for
 rich text representation.
        string description = 1;
        Parameters:
        value - The description to set.
        Returns:
        This builder for chaining.

      • clearDescription

        public Openapiv2.ExternalDocumentation.Builder clearDescription()
         A short description of the target documentation. GFM syntax can be used for
 rich text representation.
        string description = 1;
        Returns:
        This builder for chaining.

      • setDescriptionBytes

        public Openapiv2.ExternalDocumentation.Builder setDescriptionBytes​(com.google.protobuf.ByteString value)
         A short description of the target documentation. GFM syntax can be used for
 rich text representation.
        string description = 1;
        Parameters:
        value - The bytes for description to set.
        Returns:
        This builder for chaining.

      • getUrl

        public java.lang.String getUrl()
         The URL for the target documentation. Value MUST be in the format
 of a URL.
        string url = 2;
        Specified by:
        getUrl in interface Openapiv2.ExternalDocumentationOrBuilder
        Returns:
        The url.

      • getUrlBytes

        public com.google.protobuf.ByteString getUrlBytes()
         The URL for the target documentation. Value MUST be in the format
 of a URL.
        string url = 2;
        Specified by:
        getUrlBytes in interface Openapiv2.ExternalDocumentationOrBuilder
        Returns:
        The bytes for url.

      • setUrl

        public Openapiv2.ExternalDocumentation.Builder setUrl​(java.lang.String value)
         The URL for the target documentation. Value MUST be in the format
 of a URL.
        string url = 2;
        Parameters:
        value - The url to set.
        Returns:
        This builder for chaining.

      • clearUrl

        public Openapiv2.ExternalDocumentation.Builder clearUrl()
         The URL for the target documentation. Value MUST be in the format
 of a URL.
        string url = 2;
        Returns:
        This builder for chaining.

      • setUrlBytes

        public Openapiv2.ExternalDocumentation.Builder setUrlBytes​(com.google.protobuf.ByteString value)
         The URL for the target documentation. Value MUST be in the format
 of a URL.
        string url = 2;
        Parameters:
        value - The bytes for url to set.
        Returns:
        This builder for chaining.