Package grpc.gateway.protoc_gen_openapiv2.options

Class Openapiv2.License.Builder

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

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

 Example:

 option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
 info: {
 ...
 license: {
 name: "BSD 3-Clause License";
 url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/main/LICENSE";
 };
 ...
 };
 ...
 };
    Protobuf type grpc.gateway.protoc_gen_openapiv2.options.License

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Openapiv2.License build()  
      Openapiv2.License buildPartial()  
      Openapiv2.License.Builder clear()  
      Openapiv2.License.Builder clearName()
      The license name used for the API.
      Openapiv2.License.Builder clearUrl()
      A URL to the license used for the API.
      Openapiv2.License getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Descriptors.Descriptor getDescriptorForType()  
      java.lang.String getName()
      The license name used for the API.
      com.google.protobuf.ByteString getNameBytes()
      The license name used for the API.
      java.lang.String getUrl()
      A URL to the license used for the API.
      com.google.protobuf.ByteString getUrlBytes()
      A URL to the license used for the API.
      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      Openapiv2.License.Builder mergeFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      Openapiv2.License.Builder mergeFrom​(com.google.protobuf.Message other)  
      Openapiv2.License.Builder mergeFrom​(Openapiv2.License other)  
      Openapiv2.License.Builder setName​(java.lang.String value)
      The license name used for the API.
      Openapiv2.License.Builder setNameBytes​(com.google.protobuf.ByteString value)
      The license name used for the API.
      Openapiv2.License.Builder setUrl​(java.lang.String value)
      A URL to the license used for the API.
      Openapiv2.License.Builder setUrlBytes​(com.google.protobuf.ByteString value)
      A URL to the license used for the API.

      • Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

        addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

      • Methods inherited from class com.google.protobuf.AbstractMessage.Builder

        findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

        addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

      • Methods inherited from class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface com.google.protobuf.Message.Builder

        mergeDelimitedFrom, mergeDelimitedFrom

      • Methods inherited from interface com.google.protobuf.MessageLite.Builder

        mergeFrom

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Openapiv2.License.Builder>

      • clear

        public Openapiv2.License.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessage.Builder<Openapiv2.License.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.GeneratedMessage.Builder<Openapiv2.License.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • mergeFrom

        public Openapiv2.License.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Openapiv2.License.Builder>

      • isInitialized

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

      • mergeFrom

        public Openapiv2.License.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.License.Builder>
        Throws:
        java.io.IOException

      • getName

        public java.lang.String getName()
         The license name used for the API.
        string name = 1;
        Specified by:
        getName in interface Openapiv2.LicenseOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The license name used for the API.
        string name = 1;
        Specified by:
        getNameBytes in interface Openapiv2.LicenseOrBuilder
        Returns:
        The bytes for name.

      • setName

        public Openapiv2.License.Builder setName​(java.lang.String value)
         The license name used for the API.
        string name = 1;
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.

      • clearName

        public Openapiv2.License.Builder clearName()
         The license name used for the API.
        string name = 1;
        Returns:
        This builder for chaining.

      • setNameBytes

        public Openapiv2.License.Builder setNameBytes​(com.google.protobuf.ByteString value)
         The license name used for the API.
        string name = 1;
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

      • getUrl

        public java.lang.String getUrl()
         A URL to the license used for the API. MUST be in the format of a URL.
        string url = 2;
        Specified by:
        getUrl in interface Openapiv2.LicenseOrBuilder
        Returns:
        The url.

      • getUrlBytes

        public com.google.protobuf.ByteString getUrlBytes()
         A URL to the license used for the API. MUST be in the format of a URL.
        string url = 2;
        Specified by:
        getUrlBytes in interface Openapiv2.LicenseOrBuilder
        Returns:
        The bytes for url.

      • setUrl

        public Openapiv2.License.Builder setUrl​(java.lang.String value)
         A URL to the license used for the API. 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.License.Builder clearUrl()
         A URL to the license used for the API. MUST be in the format of a URL.
        string url = 2;
        Returns:
        This builder for chaining.

      • setUrlBytes

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