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_openapiv2.options.SecurityScheme| Modifier and Type | Class and Description |
|---|---|
static class |
Openapiv2.SecurityScheme.Builder
`SecurityScheme` is a representation of OpenAPI v2 specification's
Security Scheme object.
|
static class |
Openapiv2.SecurityScheme.Flow
The flow used by the OAuth2 security scheme.
|
static class |
Openapiv2.SecurityScheme.In
The location of the API key.
|
static class |
Openapiv2.SecurityScheme.Type
The type of the security scheme.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
AUTHORIZATION_URL_FIELD_NUMBER |
static int |
DESCRIPTION_FIELD_NUMBER |
static int |
EXTENSIONS_FIELD_NUMBER |
static int |
FLOW_FIELD_NUMBER |
static int |
IN_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
SCOPES_FIELD_NUMBER |
static int |
TOKEN_URL_FIELD_NUMBER |
static int |
TYPE_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsExtensions(java.lang.String key)
map<string, .google.protobuf.Value> extensions = 9; |
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getAuthorizationUrl()
The authorization URL to be used for this flow.
|
com.google.protobuf.ByteString |
getAuthorizationUrlBytes()
The authorization URL to be used for this flow.
|
static Openapiv2.SecurityScheme |
getDefaultInstance() |
Openapiv2.SecurityScheme |
getDefaultInstanceForType() |
java.lang.String |
getDescription()
A short description for security scheme.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
A short description for security scheme.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
java.util.Map<java.lang.String,com.google.protobuf.Value> |
getExtensions()
Deprecated.
|
int |
getExtensionsCount()
map<string, .google.protobuf.Value> extensions = 9; |
java.util.Map<java.lang.String,com.google.protobuf.Value> |
getExtensionsMap()
map<string, .google.protobuf.Value> extensions = 9; |
com.google.protobuf.Value |
getExtensionsOrDefault(java.lang.String key,
com.google.protobuf.Value defaultValue)
map<string, .google.protobuf.Value> extensions = 9; |
com.google.protobuf.Value |
getExtensionsOrThrow(java.lang.String key)
map<string, .google.protobuf.Value> extensions = 9; |
Openapiv2.SecurityScheme.Flow |
getFlow()
The flow used by the OAuth2 security scheme.
|
int |
getFlowValue()
The flow used by the OAuth2 security scheme.
|
Openapiv2.SecurityScheme.In |
getIn()
The location of the API key.
|
int |
getInValue()
The location of the API key.
|
java.lang.String |
getName()
The name of the header or query parameter to be used.
|
com.google.protobuf.ByteString |
getNameBytes()
The name of the header or query parameter to be used.
|
com.google.protobuf.Parser<Openapiv2.SecurityScheme> |
getParserForType() |
Openapiv2.Scopes |
getScopes()
The available scopes for the OAuth2 security scheme.
|
Openapiv2.ScopesOrBuilder |
getScopesOrBuilder()
The available scopes for the OAuth2 security scheme.
|
int |
getSerializedSize() |
java.lang.String |
getTokenUrl()
The token URL to be used for this flow.
|
com.google.protobuf.ByteString |
getTokenUrlBytes()
The token URL to be used for this flow.
|
Openapiv2.SecurityScheme.Type |
getType()
The type of the security scheme.
|
int |
getTypeValue()
The type of the security scheme.
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
int |
hashCode() |
boolean |
hasScopes()
The available scopes for the OAuth2 security scheme.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapField |
internalGetMapField(int number) |
boolean |
isInitialized() |
static Openapiv2.SecurityScheme.Builder |
newBuilder() |
static Openapiv2.SecurityScheme.Builder |
newBuilder(Openapiv2.SecurityScheme prototype) |
Openapiv2.SecurityScheme.Builder |
newBuilderForType() |
protected Openapiv2.SecurityScheme.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected java.lang.Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static Openapiv2.SecurityScheme |
parseDelimitedFrom(java.io.InputStream input) |
static Openapiv2.SecurityScheme |
parseDelimitedFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Openapiv2.SecurityScheme |
parseFrom(byte[] data) |
static Openapiv2.SecurityScheme |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Openapiv2.SecurityScheme |
parseFrom(java.nio.ByteBuffer data) |
static Openapiv2.SecurityScheme |
parseFrom(java.nio.ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Openapiv2.SecurityScheme |
parseFrom(com.google.protobuf.ByteString data) |
static Openapiv2.SecurityScheme |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Openapiv2.SecurityScheme |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Openapiv2.SecurityScheme |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Openapiv2.SecurityScheme |
parseFrom(java.io.InputStream input) |
static Openapiv2.SecurityScheme |
parseFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Openapiv2.SecurityScheme> |
parser() |
Openapiv2.SecurityScheme.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, 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, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int TYPE_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
public static final int IN_FIELD_NUMBER
public static final int FLOW_FIELD_NUMBER
public static final int AUTHORIZATION_URL_FIELD_NUMBER
public static final int TOKEN_URL_FIELD_NUMBER
public static final int SCOPES_FIELD_NUMBER
public static final int EXTENSIONS_FIELD_NUMBER
protected java.lang.Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField in class com.google.protobuf.GeneratedMessageV3protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public int getTypeValue()
The type of the security scheme. Valid values are "basic", "apiKey" or "oauth2".
.grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.Type type = 1;getTypeValue in interface Openapiv2.SecuritySchemeOrBuilderpublic Openapiv2.SecurityScheme.Type getType()
The type of the security scheme. Valid values are "basic", "apiKey" or "oauth2".
.grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.Type type = 1;getType in interface Openapiv2.SecuritySchemeOrBuilderpublic java.lang.String getDescription()
A short description for security scheme.
string description = 2;getDescription in interface Openapiv2.SecuritySchemeOrBuilderpublic com.google.protobuf.ByteString getDescriptionBytes()
A short description for security scheme.
string description = 2;getDescriptionBytes in interface Openapiv2.SecuritySchemeOrBuilderpublic java.lang.String getName()
The name of the header or query parameter to be used. Valid for apiKey.
string name = 3;getName in interface Openapiv2.SecuritySchemeOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
The name of the header or query parameter to be used. Valid for apiKey.
string name = 3;getNameBytes in interface Openapiv2.SecuritySchemeOrBuilderpublic int getInValue()
The location of the API key. Valid values are "query" or "header". Valid for apiKey.
.grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.In in = 4;getInValue in interface Openapiv2.SecuritySchemeOrBuilderpublic Openapiv2.SecurityScheme.In getIn()
The location of the API key. Valid values are "query" or "header". Valid for apiKey.
.grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.In in = 4;getIn in interface Openapiv2.SecuritySchemeOrBuilderpublic 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_openapiv2.options.SecurityScheme.Flow flow = 5;getFlowValue in interface Openapiv2.SecuritySchemeOrBuilderpublic 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_openapiv2.options.SecurityScheme.Flow flow = 5;getFlow in interface Openapiv2.SecuritySchemeOrBuilderpublic java.lang.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;getAuthorizationUrl in interface Openapiv2.SecuritySchemeOrBuilderpublic 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;getAuthorizationUrlBytes in interface Openapiv2.SecuritySchemeOrBuilderpublic java.lang.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;getTokenUrl in interface Openapiv2.SecuritySchemeOrBuilderpublic 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;getTokenUrlBytes in interface Openapiv2.SecuritySchemeOrBuilderpublic boolean hasScopes()
The available scopes for the OAuth2 security scheme. Valid for oauth2.
.grpc.gateway.protoc_gen_openapiv2.options.Scopes scopes = 8;hasScopes in interface Openapiv2.SecuritySchemeOrBuilderpublic Openapiv2.Scopes getScopes()
The available scopes for the OAuth2 security scheme. Valid for oauth2.
.grpc.gateway.protoc_gen_openapiv2.options.Scopes scopes = 8;getScopes in interface Openapiv2.SecuritySchemeOrBuilderpublic Openapiv2.ScopesOrBuilder getScopesOrBuilder()
The available scopes for the OAuth2 security scheme. Valid for oauth2.
.grpc.gateway.protoc_gen_openapiv2.options.Scopes scopes = 8;getScopesOrBuilder in interface Openapiv2.SecuritySchemeOrBuilderpublic int getExtensionsCount()
Openapiv2.SecuritySchemeOrBuildermap<string, .google.protobuf.Value> extensions = 9;getExtensionsCount in interface Openapiv2.SecuritySchemeOrBuilderpublic boolean containsExtensions(java.lang.String key)
map<string, .google.protobuf.Value> extensions = 9;containsExtensions in interface Openapiv2.SecuritySchemeOrBuilder@Deprecated public java.util.Map<java.lang.String,com.google.protobuf.Value> getExtensions()
getExtensionsMap() instead.getExtensions in interface Openapiv2.SecuritySchemeOrBuilderpublic java.util.Map<java.lang.String,com.google.protobuf.Value> getExtensionsMap()
map<string, .google.protobuf.Value> extensions = 9;getExtensionsMap in interface Openapiv2.SecuritySchemeOrBuilderpublic com.google.protobuf.Value getExtensionsOrDefault(java.lang.String key,
com.google.protobuf.Value defaultValue)
map<string, .google.protobuf.Value> extensions = 9;getExtensionsOrDefault in interface Openapiv2.SecuritySchemeOrBuilderpublic com.google.protobuf.Value getExtensionsOrThrow(java.lang.String key)
map<string, .google.protobuf.Value> extensions = 9;getExtensionsOrThrow in interface Openapiv2.SecuritySchemeOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws java.io.IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3java.io.IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(java.lang.Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Openapiv2.SecurityScheme parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Openapiv2.SecurityScheme parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Openapiv2.SecurityScheme parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Openapiv2.SecurityScheme parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Openapiv2.SecurityScheme parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Openapiv2.SecurityScheme parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Openapiv2.SecurityScheme parseFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOExceptionpublic static Openapiv2.SecurityScheme parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic static Openapiv2.SecurityScheme parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOExceptionpublic static Openapiv2.SecurityScheme parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic static Openapiv2.SecurityScheme parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
java.io.IOExceptionpublic static Openapiv2.SecurityScheme parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic Openapiv2.SecurityScheme.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Openapiv2.SecurityScheme.Builder newBuilder()
public static Openapiv2.SecurityScheme.Builder newBuilder(Openapiv2.SecurityScheme prototype)
public Openapiv2.SecurityScheme.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Openapiv2.SecurityScheme.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Openapiv2.SecurityScheme getDefaultInstance()
public static com.google.protobuf.Parser<Openapiv2.SecurityScheme> parser()
public com.google.protobuf.Parser<Openapiv2.SecurityScheme> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Openapiv2.SecurityScheme getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder