SecurityScheme (nakama-java 2.5.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessage
    - - com.grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme

All Implemented Interfaces:: com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SecuritySchemeOrBuilder, java.io.Serializable

public final class SecurityScheme
extends com.google.protobuf.GeneratedMessage
implements 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

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SecurityScheme.Builder` `SecurityScheme` is a representation of OpenAPI v2 specification's Security Scheme object.
`static class`	`SecurityScheme.Flow` The flow used by the OAuth2 security scheme.
`static class`	`SecurityScheme.In` The location of the API key.
`static class`	`SecurityScheme.Type` The type of the security scheme.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParent

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

Field Summary

Fields
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`

Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsExtensions(java.lang.String key)` Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.
`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 SecurityScheme`	`getDefaultInstance()`
`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()` Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.
`java.util.Map<java.lang.String,com.google.protobuf.Value>`	`getExtensionsMap()` Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.
`com.google.protobuf.Value`	`getExtensionsOrDefault(java.lang.String key, com.google.protobuf.Value defaultValue)` Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.
`com.google.protobuf.Value`	`getExtensionsOrThrow(java.lang.String key)` Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.
`SecurityScheme.Flow`	`getFlow()` The flow used by the OAuth2 security scheme.
`int`	`getFlowValue()` The flow used by the OAuth2 security scheme.
`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<SecurityScheme>`	`getParserForType()`
`Scopes`	`getScopes()` The available scopes for the OAuth2 security scheme.
`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.
`SecurityScheme.Type`	`getType()` The type of the security scheme.
`int`	`getTypeValue()` The type of the security scheme.
`int`	`hashCode()`
`boolean`	`hasScopes()` The available scopes for the OAuth2 security scheme.
`protected com.google.protobuf.GeneratedMessage.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapFieldReflectionAccessor`	`internalGetMapFieldReflection(int number)`
`boolean`	`isInitialized()`
`static SecurityScheme.Builder`	`newBuilder()`
`static SecurityScheme.Builder`	`newBuilder(SecurityScheme prototype)`
`SecurityScheme.Builder`	`newBuilderForType()`
`protected SecurityScheme.Builder`	`newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)`
`static SecurityScheme`	`parseDelimitedFrom(java.io.InputStream input)`
`static SecurityScheme`	`parseDelimitedFrom(java.io.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(java.nio.ByteBuffer data)`
`static SecurityScheme`	`parseFrom(java.nio.ByteBuffer 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(java.io.InputStream input)`
`static SecurityScheme`	`parseFrom(java.io.InputStream input, 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.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
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.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- TYPE_FIELD_NUMBER
```
public static final int TYPE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DESCRIPTION_FIELD_NUMBER
```
public static final int DESCRIPTION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NAME_FIELD_NUMBER
```
public static final int NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- IN_FIELD_NUMBER
```
public static final int IN_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- FLOW_FIELD_NUMBER
```
public static final int FLOW_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- AUTHORIZATION_URL_FIELD_NUMBER
```
public static final int AUTHORIZATION_URL_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TOKEN_URL_FIELD_NUMBER
```
public static final int TOKEN_URL_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SCOPES_FIELD_NUMBER
```
public static final int SCOPES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- EXTENSIONS_FIELD_NUMBER
```
public static final int EXTENSIONS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

getDescriptor

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

internalGetMapFieldReflection
```
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
```
Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getTypeValue
```
public 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 [json_name = "type"];
Specified by:

getTypeValue in interface SecuritySchemeOrBuilder

Returns:

The enum numeric value on the wire for type.

getType
```
public 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 [json_name = "type"];
Specified by:

getType in interface SecuritySchemeOrBuilder

Returns:

The type.

getDescription
```
public java.lang.String getDescription()
```
```
 A short description for security scheme.
 
```
string description = 2 [json_name = "description"];
Specified by:

getDescription in interface SecuritySchemeOrBuilder

Returns:

The description.

getDescriptionBytes
```
public com.google.protobuf.ByteString getDescriptionBytes()
```
```
 A short description for security scheme.
 
```
string description = 2 [json_name = "description"];
Specified by:

getDescriptionBytes in interface SecuritySchemeOrBuilder

Returns:

The bytes for description.

getName
```
public java.lang.String getName()
```
```
 The name of the header or query parameter to be used.
 Valid for apiKey.
 
```
string name = 3 [json_name = "name"];
Specified by:

getName in interface SecuritySchemeOrBuilder

Returns:

The name.

getNameBytes
```
public com.google.protobuf.ByteString getNameBytes()
```
```
 The name of the header or query parameter to be used.
 Valid for apiKey.
 
```
string name = 3 [json_name = "name"];
Specified by:

getNameBytes in interface 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_openapiv2.options.SecurityScheme.In in = 4 [json_name = "in"];
Specified by:

getInValue in interface SecuritySchemeOrBuilder

Returns:

The enum numeric value on the wire for in.

getIn
```
public 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 [json_name = "in"];
Specified by:

getIn in interface SecuritySchemeOrBuilder

Returns:

The 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_openapiv2.options.SecurityScheme.Flow flow = 5 [json_name = "flow"];
Specified by:

getFlowValue in interface SecuritySchemeOrBuilder

Returns:

The enum numeric value on the wire for flow.

getFlow

public 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 [json_name = "flow"];

Specified by:: getFlow in interface SecuritySchemeOrBuilder
Returns:: The flow.

getAuthorizationUrl

public 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 [json_name = "authorizationUrl"];

Specified by:: getAuthorizationUrl in interface 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 [json_name = "authorizationUrl"];

Specified by:: getAuthorizationUrlBytes in interface SecuritySchemeOrBuilder
Returns:: The bytes for authorizationUrl.

getTokenUrl

public 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 [json_name = "tokenUrl"];

Specified by:: getTokenUrl in interface 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 [json_name = "tokenUrl"];

Specified by:: getTokenUrlBytes in interface 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_openapiv2.options.Scopes scopes = 8 [json_name = "scopes"];
Specified by:

hasScopes in interface SecuritySchemeOrBuilder

Returns:

Whether the scopes field is set.

getScopes
```
public Scopes getScopes()
```
```
 The available scopes for the OAuth2 security scheme.
 Valid for oauth2.
 
```
.grpc.gateway.protoc_gen_openapiv2.options.Scopes scopes = 8 [json_name = "scopes"];
Specified by:

getScopes in interface SecuritySchemeOrBuilder

Returns:

The scopes.

getScopesOrBuilder
```
public ScopesOrBuilder getScopesOrBuilder()
```
```
 The available scopes for the OAuth2 security scheme.
 Valid for oauth2.
 
```
.grpc.gateway.protoc_gen_openapiv2.options.Scopes scopes = 8 [json_name = "scopes"];
Specified by:

getScopesOrBuilder in interface SecuritySchemeOrBuilder