Package grpc.gateway.protoc_gen_swagger.options

Class Openapiv2.SecurityScheme

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Openapiv2.SecuritySchemeOrBuilder, Serializable
    Enclosing class:
    Openapiv2
    public static final class Openapiv2.SecurityScheme
extends com.google.protobuf.GeneratedMessageV3
implements Openapiv2.SecuritySchemeOrBuilder
     `SecurityScheme` is a representation of OpenAPI v2 specification's
 Security Scheme object.
 See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#securitySchemeObject
 Allows the definition of a security scheme that can be used by the
 operations. Supported schemes are basic authentication, an API key (either as
 a header or as a query parameter) and OAuth2's common flows (implicit,
 password, application and access code).
    Protobuf type grpc.gateway.protoc_gen_swagger.options.SecurityScheme
    See Also:
    Serialized Form

    • Field Detail

      • type_

        private int type_

      • DESCRIPTION_FIELD_NUMBER

        public static final int DESCRIPTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • description_

        private volatile Object description_

      • name_

        private volatile Object name_

      • in_

        private int in_

      • flow_

        private int flow_

      • AUTHORIZATION_URL_FIELD_NUMBER

        public static final int AUTHORIZATION_URL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • authorizationUrl_

        private volatile Object authorizationUrl_

      • tokenUrl_

        private volatile Object tokenUrl_

      • EXTENSIONS_FIELD_NUMBER

        public static final int EXTENSIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • extensions_

        private com.google.protobuf.MapField<String,​com.google.protobuf.Value> extensions_

      • memoizedIsInitialized

        private byte memoizedIsInitialized

    • Constructor Detail

      • SecurityScheme

        private SecurityScheme​(com.google.protobuf.GeneratedMessageV3.Builder<?> builder)

      • SecurityScheme

        private SecurityScheme()

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • 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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getTypeValue

        public int getTypeValue()
         The type of the security scheme. Valid values are "basic",
 "apiKey" or "oauth2".
        .grpc.gateway.protoc_gen_swagger.options.SecurityScheme.Type type = 1;
        Specified by:
        getTypeValue in interface Openapiv2.SecuritySchemeOrBuilder
        Returns:
        The enum numeric value on the wire for type.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         A short description for security scheme.
        string description = 2;
        Specified by:
        getDescriptionBytes in interface Openapiv2.SecuritySchemeOrBuilder
        Returns:
        The bytes for description.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The name of the header or query parameter to be used.
 Valid for apiKey.
        string name = 3;
        Specified by:
        getNameBytes in interface Openapiv2.SecuritySchemeOrBuilder
        Returns:
        The bytes for name.

      • getInValue

        public int getInValue()
         The location of the API key. Valid values are "query" or
 "header".
 Valid for apiKey.
        .grpc.gateway.protoc_gen_swagger.options.SecurityScheme.In in = 4;
        Specified by:
        getInValue in interface Openapiv2.SecuritySchemeOrBuilder
        Returns:
        The enum numeric value on the wire for in.

      • getFlowValue

        public int getFlowValue()
         The flow used by the OAuth2 security scheme. Valid values are
 "implicit", "password", "application" or "accessCode".
 Valid for oauth2.
        .grpc.gateway.protoc_gen_swagger.options.SecurityScheme.Flow flow = 5;
        Specified by:
        getFlowValue in interface Openapiv2.SecuritySchemeOrBuilder
        Returns:
        The enum numeric value on the wire for flow.

      • getFlow

        public Openapiv2.SecurityScheme.Flow getFlow()
         The flow used by the OAuth2 security scheme. Valid values are
 "implicit", "password", "application" or "accessCode".
 Valid for oauth2.
        .grpc.gateway.protoc_gen_swagger.options.SecurityScheme.Flow flow = 5;
        Specified by:
        getFlow in interface Openapiv2.SecuritySchemeOrBuilder
        Returns:
        The flow.

      • getAuthorizationUrl

        public String getAuthorizationUrl()
         The authorization URL to be used for this flow. This SHOULD be in
 the form of a URL.
 Valid for oauth2/implicit and oauth2/accessCode.
        string authorization_url = 6;
        Specified by:
        getAuthorizationUrl in interface Openapiv2.SecuritySchemeOrBuilder
        Returns:
        The authorizationUrl.

      • getAuthorizationUrlBytes

        public com.google.protobuf.ByteString getAuthorizationUrlBytes()
         The authorization URL to be used for this flow. This SHOULD be in
 the form of a URL.
 Valid for oauth2/implicit and oauth2/accessCode.
        string authorization_url = 6;
        Specified by:
        getAuthorizationUrlBytes in interface Openapiv2.SecuritySchemeOrBuilder
        Returns:
        The bytes for authorizationUrl.

      • getTokenUrl

        public String getTokenUrl()
         The token URL to be used for this flow. This SHOULD be in the
 form of a URL.
 Valid for oauth2/password, oauth2/application and oauth2/accessCode.
        string token_url = 7;
        Specified by:
        getTokenUrl in interface Openapiv2.SecuritySchemeOrBuilder
        Returns:
        The tokenUrl.

      • getTokenUrlBytes

        public com.google.protobuf.ByteString getTokenUrlBytes()
         The token URL to be used for this flow. This SHOULD be in the
 form of a URL.
 Valid for oauth2/password, oauth2/application and oauth2/accessCode.
        string token_url = 7;
        Specified by:
        getTokenUrlBytes in interface Openapiv2.SecuritySchemeOrBuilder
        Returns:
        The bytes for tokenUrl.

      • hasScopes

        public boolean hasScopes()
         The available scopes for the OAuth2 security scheme.
 Valid for oauth2.
        .grpc.gateway.protoc_gen_swagger.options.Scopes scopes = 8;
        Specified by:
        hasScopes in interface Openapiv2.SecuritySchemeOrBuilder
        Returns:
        Whether the scopes field is set.

      • internalGetExtensions

        private com.google.protobuf.MapField<String,​com.google.protobuf.Value> internalGetExtensions()

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Openapiv2.SecurityScheme parseFrom​(ByteBuffer data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Openapiv2.SecurityScheme parseFrom​(ByteBuffer data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Openapiv2.SecurityScheme parseFrom​(com.google.protobuf.ByteString data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Openapiv2.SecurityScheme parseFrom​(com.google.protobuf.ByteString data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Openapiv2.SecurityScheme parseFrom​(byte[] data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Openapiv2.SecurityScheme parseFrom​(byte[] data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected Openapiv2.SecurityScheme.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<Openapiv2.SecurityScheme> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

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