Package grpc.gateway.protoc_gen_openapiv2.options

Class Openapiv2.Scopes.Builder

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

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

 Lists the available scopes for an OAuth2 security scheme.
    Protobuf type grpc.gateway.protoc_gen_openapiv2.options.Scopes

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      Openapiv2.Scopes.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)  
      Openapiv2.Scopes build()  
      Openapiv2.Scopes buildPartial()  
      Openapiv2.Scopes.Builder clear()  
      Openapiv2.Scopes.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)  
      Openapiv2.Scopes.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)  
      Openapiv2.Scopes.Builder clearScope()  
      Openapiv2.Scopes.Builder clone()  
      boolean containsScope​(java.lang.String key)
      Maps between a name of a scope to a short description of it (as the value of the property).
      Openapiv2.Scopes getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Descriptors.Descriptor getDescriptorForType()  
      java.util.Map<java.lang.String,​java.lang.String> getMutableScope()
      Deprecated.
      java.util.Map<java.lang.String,​java.lang.String> getScope()
      Deprecated.
      int getScopeCount()
      Maps between a name of a scope to a short description of it (as the value of the property).
      java.util.Map<java.lang.String,​java.lang.String> getScopeMap()
      Maps between a name of a scope to a short description of it (as the value of the property).
      java.lang.String getScopeOrDefault​(java.lang.String key, java.lang.String defaultValue)
      Maps between a name of a scope to a short description of it (as the value of the property).
      java.lang.String getScopeOrThrow​(java.lang.String key)
      Maps between a name of a scope to a short description of it (as the value of the property).
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      protected com.google.protobuf.MapField internalGetMapField​(int number)  
      protected com.google.protobuf.MapField internalGetMutableMapField​(int number)  
      boolean isInitialized()  
      Openapiv2.Scopes.Builder mergeFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      Openapiv2.Scopes.Builder mergeFrom​(com.google.protobuf.Message other)  
      Openapiv2.Scopes.Builder mergeFrom​(Openapiv2.Scopes other)  
      Openapiv2.Scopes.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)  
      Openapiv2.Scopes.Builder putAllScope​(java.util.Map<java.lang.String,​java.lang.String> values)
      Maps between a name of a scope to a short description of it (as the value of the property).
      Openapiv2.Scopes.Builder putScope​(java.lang.String key, java.lang.String value)
      Maps between a name of a scope to a short description of it (as the value of the property).
      Openapiv2.Scopes.Builder removeScope​(java.lang.String key)
      Maps between a name of a scope to a short description of it (as the value of the property).
      Openapiv2.Scopes.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)  
      Openapiv2.Scopes.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)  
      Openapiv2.Scopes.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)  

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

        getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, 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()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Scopes.Builder>

      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Scopes.Builder>

      • internalGetFieldAccessorTable

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

      • clear

        public Openapiv2.Scopes.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.GeneratedMessageV3.Builder<Openapiv2.Scopes.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.Scopes.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public Openapiv2.Scopes.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Scopes.Builder>

      • setField

        public Openapiv2.Scopes.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         java.lang.Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Scopes.Builder>

      • clearField

        public Openapiv2.Scopes.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Scopes.Builder>

      • clearOneof

        public Openapiv2.Scopes.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Scopes.Builder>

      • setRepeatedField

        public Openapiv2.Scopes.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 int index,
                                                 java.lang.Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Scopes.Builder>

      • addRepeatedField

        public Openapiv2.Scopes.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Scopes.Builder>

      • mergeFrom

        public Openapiv2.Scopes.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.Scopes.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.Scopes.Builder>

      • mergeFrom

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

      • containsScope

        public boolean containsScope​(java.lang.String key)
         Maps between a name of a scope to a short description of it (as the value
 of the property).
        map<string, string> scope = 1;
        Specified by:
        containsScope in interface Openapiv2.ScopesOrBuilder

      • getScopeMap

        public java.util.Map<java.lang.String,​java.lang.String> getScopeMap()
         Maps between a name of a scope to a short description of it (as the value
 of the property).
        map<string, string> scope = 1;
        Specified by:
        getScopeMap in interface Openapiv2.ScopesOrBuilder

      • getScopeOrDefault

        public java.lang.String getScopeOrDefault​(java.lang.String key,
                                          java.lang.String defaultValue)
         Maps between a name of a scope to a short description of it (as the value
 of the property).
        map<string, string> scope = 1;
        Specified by:
        getScopeOrDefault in interface Openapiv2.ScopesOrBuilder

      • getScopeOrThrow

        public java.lang.String getScopeOrThrow​(java.lang.String key)
         Maps between a name of a scope to a short description of it (as the value
 of the property).
        map<string, string> scope = 1;
        Specified by:
        getScopeOrThrow in interface Openapiv2.ScopesOrBuilder

      • removeScope

        public Openapiv2.Scopes.Builder removeScope​(java.lang.String key)
         Maps between a name of a scope to a short description of it (as the value
 of the property).
        map<string, string> scope = 1;

      • getMutableScope

        @Deprecated
public java.util.Map<java.lang.String,​java.lang.String> getMutableScope()
        Deprecated.
        Use alternate mutation accessors instead.

      • putScope

        public Openapiv2.Scopes.Builder putScope​(java.lang.String key,
                                         java.lang.String value)
         Maps between a name of a scope to a short description of it (as the value
 of the property).
        map<string, string> scope = 1;

      • putAllScope

        public Openapiv2.Scopes.Builder putAllScope​(java.util.Map<java.lang.String,​java.lang.String> values)
         Maps between a name of a scope to a short description of it (as the value
 of the property).
        map<string, string> scope = 1;

      • setUnknownFields

        public final Openapiv2.Scopes.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Scopes.Builder>

      • mergeUnknownFields

        public final Openapiv2.Scopes.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Scopes.Builder>