Package com.openapi.v3

Class SecurityScheme

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.openapi.v3.SecurityScheme
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SecuritySchemeOrBuilder, Serializable
public final class SecurityScheme extends com.google.protobuf.GeneratedMessageV3 implements SecuritySchemeOrBuilder
 Defines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), mutual TLS (use of a client certificate), OAuth2's common flows (implicit, password, application and access code) as defined in RFC6749, and OpenID Connect.   Please note that currently (2019) the implicit flow is about to be deprecated OAuth 2.0 Security Best Current Practice. Recommended for most use case is Authorization Code Grant flow with PKCE.
Protobuf type openapi.v3.SecurityScheme
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    SecurityScheme.Builder
    Defines a security scheme that can be used by the operations.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    BEARER_FORMAT_FIELD_NUMBER
     
    static final int
    DESCRIPTION_FIELD_NUMBER
     
    static final int
    FLOWS_FIELD_NUMBER
     
    static final int
    IN_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    OPEN_ID_CONNECT_URL_FIELD_NUMBER
     
    static final int
    SCHEME_FIELD_NUMBER
     
    static final int
    SPECIFICATION_EXTENSION_FIELD_NUMBER
     
    static final int
    TYPE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    String
    getBearerFormat()
    string bearer_format = 6 [json_name = "bearerFormat"];
    com.google.protobuf.ByteString
    getBearerFormatBytes()
    string bearer_format = 6 [json_name = "bearerFormat"];
    static SecurityScheme
    getDefaultInstance()
     
    SecurityScheme
    getDefaultInstanceForType()
     
    String
    getDescription()
    string description = 2 [json_name = "description"];
    com.google.protobuf.ByteString
    getDescriptionBytes()
    string description = 2 [json_name = "description"];
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    OauthFlows
    getFlows()
    .openapi.v3.OauthFlows flows = 7 [json_name = "flows"];
    OauthFlowsOrBuilder
    getFlowsOrBuilder()
    .openapi.v3.OauthFlows flows = 7 [json_name = "flows"];
    String
    getIn()
    string in = 4 [json_name = "in"];
    com.google.protobuf.ByteString
    getInBytes()
    string in = 4 [json_name = "in"];
    String
    getName()
    string name = 3 [json_name = "name"];
    com.google.protobuf.ByteString
    getNameBytes()
    string name = 3 [json_name = "name"];
    String
    getOpenIdConnectUrl()
    string open_id_connect_url = 8 [json_name = "openIdConnectUrl"];
    com.google.protobuf.ByteString
    getOpenIdConnectUrlBytes()
    string open_id_connect_url = 8 [json_name = "openIdConnectUrl"];
    com.google.protobuf.Parser<SecurityScheme>
    getParserForType()
     
    String
    getScheme()
    string scheme = 5 [json_name = "scheme"];
    com.google.protobuf.ByteString
    getSchemeBytes()
    string scheme = 5 [json_name = "scheme"];
    int
    getSerializedSize()
     
    NamedAny
    getSpecificationExtension(int index)
    repeated .openapi.v3.NamedAny specification_extension = 9 [json_name = "specificationExtension"];
    int
    getSpecificationExtensionCount()
    repeated .openapi.v3.NamedAny specification_extension = 9 [json_name = "specificationExtension"];
    List<NamedAny>
    getSpecificationExtensionList()
    repeated .openapi.v3.NamedAny specification_extension = 9 [json_name = "specificationExtension"];
    NamedAnyOrBuilder
    getSpecificationExtensionOrBuilder(int index)
    repeated .openapi.v3.NamedAny specification_extension = 9 [json_name = "specificationExtension"];
    List<? extends NamedAnyOrBuilder>
    getSpecificationExtensionOrBuilderList()
    repeated .openapi.v3.NamedAny specification_extension = 9 [json_name = "specificationExtension"];
    String
    getType()
    string type = 1 [json_name = "type"];
    com.google.protobuf.ByteString
    getTypeBytes()
    string type = 1 [json_name = "type"];
    boolean
    hasFlows()
    .openapi.v3.OauthFlows flows = 7 [json_name = "flows"];
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static SecurityScheme.Builder
    newBuilder()
     
    static SecurityScheme.Builder
    newBuilder(SecurityScheme prototype)
     
    SecurityScheme.Builder
    newBuilderForType()
     
    protected SecurityScheme.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static SecurityScheme
    parseDelimitedFrom(InputStream input)
     
    static SecurityScheme
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SecurityScheme
    parseFrom(byte[] data)
     
    static SecurityScheme
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SecurityScheme
    parseFrom(com.google.protobuf.ByteString data)
     
    static SecurityScheme
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SecurityScheme
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static SecurityScheme
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SecurityScheme
    parseFrom(InputStream input)
     
    static SecurityScheme
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SecurityScheme
    parseFrom(ByteBuffer data)
     
    static SecurityScheme
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<SecurityScheme>
    parser()
     
    SecurityScheme.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • TYPE_FIELD_NUMBER

      public static final int TYPE_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • IN_FIELD_NUMBER

      public static final int IN_FIELD_NUMBER
      See Also:

    • SCHEME_FIELD_NUMBER

      public static final int SCHEME_FIELD_NUMBER
      See Also:

    • BEARER_FORMAT_FIELD_NUMBER

      public static final int BEARER_FORMAT_FIELD_NUMBER
      See Also:

    • FLOWS_FIELD_NUMBER

      public static final int FLOWS_FIELD_NUMBER
      See Also:

    • OPEN_ID_CONNECT_URL_FIELD_NUMBER

      public static final int OPEN_ID_CONNECT_URL_FIELD_NUMBER
      See Also:

    • SPECIFICATION_EXTENSION_FIELD_NUMBER

      public static final int SPECIFICATION_EXTENSION_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

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

    • 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

    • getType

      public String getType()
      string type = 1 [json_name = "type"];
      Specified by:
      getType in interface SecuritySchemeOrBuilder
      Returns:
      The type.

    • getTypeBytes

      public com.google.protobuf.ByteString getTypeBytes()
      string type = 1 [json_name = "type"];
      Specified by:
      getTypeBytes in interface SecuritySchemeOrBuilder
      Returns:
      The bytes for type.

    • getDescription

      public String getDescription()
      string description = 2 [json_name = "description"];
      Specified by:
      getDescription in interface SecuritySchemeOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
      string description = 2 [json_name = "description"];
      Specified by:
      getDescriptionBytes in interface SecuritySchemeOrBuilder
      Returns:
      The bytes for description.

    • getName

      public String getName()
      string name = 3 [json_name = "name"];
      Specified by:
      getName in interface SecuritySchemeOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
      string name = 3 [json_name = "name"];
      Specified by:
      getNameBytes in interface SecuritySchemeOrBuilder
      Returns:
      The bytes for name.

    • getIn

      public String getIn()
      string in = 4 [json_name = "in"];
      Specified by:
      getIn in interface SecuritySchemeOrBuilder
      Returns:
      The in.

    • getInBytes

      public com.google.protobuf.ByteString getInBytes()
      string in = 4 [json_name = "in"];
      Specified by:
      getInBytes in interface SecuritySchemeOrBuilder
      Returns:
      The bytes for in.

    • getScheme

      public String getScheme()
      string scheme = 5 [json_name = "scheme"];
      Specified by:
      getScheme in interface SecuritySchemeOrBuilder
      Returns:
      The scheme.

    • getSchemeBytes

      public com.google.protobuf.ByteString getSchemeBytes()
      string scheme = 5 [json_name = "scheme"];
      Specified by:
      getSchemeBytes in interface SecuritySchemeOrBuilder
      Returns:
      The bytes for scheme.

    • getBearerFormat

      public String getBearerFormat()
      string bearer_format = 6 [json_name = "bearerFormat"];
      Specified by:
      getBearerFormat in interface SecuritySchemeOrBuilder
      Returns:
      The bearerFormat.

    • getBearerFormatBytes

      public com.google.protobuf.ByteString getBearerFormatBytes()
      string bearer_format = 6 [json_name = "bearerFormat"];
      Specified by:
      getBearerFormatBytes in interface SecuritySchemeOrBuilder
      Returns:
      The bytes for bearerFormat.

    • hasFlows

      public boolean hasFlows()
      .openapi.v3.OauthFlows flows = 7 [json_name = "flows"];
      Specified by:
      hasFlows in interface SecuritySchemeOrBuilder
      Returns:
      Whether the flows field is set.

    • getFlows

      public OauthFlows getFlows()
      .openapi.v3.OauthFlows flows = 7 [json_name = "flows"];
      Specified by:
      getFlows in interface SecuritySchemeOrBuilder
      Returns:
      The flows.

    • getFlowsOrBuilder

      public OauthFlowsOrBuilder getFlowsOrBuilder()
      .openapi.v3.OauthFlows flows = 7 [json_name = "flows"];
      Specified by:
      getFlowsOrBuilder in interface SecuritySchemeOrBuilder

    • getOpenIdConnectUrl

      public String getOpenIdConnectUrl()
      string open_id_connect_url = 8 [json_name = "openIdConnectUrl"];
      Specified by:
      getOpenIdConnectUrl in interface SecuritySchemeOrBuilder
      Returns:
      The openIdConnectUrl.

    • getOpenIdConnectUrlBytes

      public com.google.protobuf.ByteString getOpenIdConnectUrlBytes()
      string open_id_connect_url = 8 [json_name = "openIdConnectUrl"];
      Specified by:
      getOpenIdConnectUrlBytes in interface SecuritySchemeOrBuilder
      Returns:
      The bytes for openIdConnectUrl.

    • getSpecificationExtensionList

      public List<NamedAny> getSpecificationExtensionList()
      repeated .openapi.v3.NamedAny specification_extension = 9 [json_name = "specificationExtension"];
      Specified by:
      getSpecificationExtensionList in interface SecuritySchemeOrBuilder

    • getSpecificationExtensionOrBuilderList

      public List<? extends NamedAnyOrBuilder> getSpecificationExtensionOrBuilderList()
      repeated .openapi.v3.NamedAny specification_extension = 9 [json_name = "specificationExtension"];
      Specified by:
      getSpecificationExtensionOrBuilderList in interface SecuritySchemeOrBuilder

    • getSpecificationExtensionCount

      public int getSpecificationExtensionCount()
      repeated .openapi.v3.NamedAny specification_extension = 9 [json_name = "specificationExtension"];
      Specified by:
      getSpecificationExtensionCount in interface SecuritySchemeOrBuilder

    • getSpecificationExtension

      public NamedAny getSpecificationExtension(int index)
      repeated .openapi.v3.NamedAny specification_extension = 9 [json_name = "specificationExtension"];
      Specified by:
      getSpecificationExtension in interface SecuritySchemeOrBuilder

    • getSpecificationExtensionOrBuilder

      public NamedAnyOrBuilder getSpecificationExtensionOrBuilder(int index)
      repeated .openapi.v3.NamedAny specification_extension = 9 [json_name = "specificationExtension"];
      Specified by:
      getSpecificationExtensionOrBuilder in interface SecuritySchemeOrBuilder

    • 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 SecurityScheme parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static 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 SecurityScheme parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static SecurityScheme parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SecurityScheme parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SecurityScheme parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SecurityScheme parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SecurityScheme parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SecurityScheme parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static SecurityScheme.Builder newBuilder()

    • newBuilder

      public static SecurityScheme.Builder newBuilder(SecurityScheme prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static SecurityScheme getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SecurityScheme> parser()

    • getParserForType

      public com.google.protobuf.Parser<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 SecurityScheme getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder