com.grpc.gateway.protoc_gen_openapiv2.options

Class Scopes

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.grpc.gateway.protoc_gen_openapiv2.options.Scopes

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ScopesOrBuilder, java.io.Serializable

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Scopes.Builder `Scopes` is a representation of OpenAPI v2 specification's Scopes object.

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	SCOPE_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

Modifier and Type	Method and Description
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).
boolean	equals(java.lang.Object obj)
static Scopes	getDefaultInstance()
Scopes	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<Scopes>	getParserForType()
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).
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMapFieldReflection(int number)
boolean	isInitialized()
static Scopes.Builder	newBuilder()
static Scopes.Builder	newBuilder(Scopes prototype)
Scopes.Builder	newBuilderForType()
protected Scopes.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static Scopes	parseDelimitedFrom(java.io.InputStream input)
static Scopes	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Scopes	parseFrom(byte[] data)
static Scopes	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Scopes	parseFrom(java.nio.ByteBuffer data)
static Scopes	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Scopes	parseFrom(com.google.protobuf.ByteString data)
static Scopes	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Scopes	parseFrom(com.google.protobuf.CodedInputStream input)
static Scopes	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Scopes	parseFrom(java.io.InputStream input)
static Scopes	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Scopes>	parser()
Scopes.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

SCOPE_FIELD_NUMBER

public static final int SCOPE_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

getScopeCount

public int getScopeCount()

Description copied from interface: ScopesOrBuilder

 Maps between a name of a scope to a short description of it (as the value
 of the property).
 

map<string, string> scope = 1 [json_name = "scope"];

Specified by:

getScopeCount in interface ScopesOrBuilder

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

Specified by:

containsScope in interface ScopesOrBuilder

getScope

@Deprecated
public java.util.Map<java.lang.String,java.lang.String> getScope()

Deprecated.

Use getScopeMap() instead.

Specified by:

getScope in interface 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 [json_name = "scope"];

Specified by:

getScopeMap in interface 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 [json_name = "scope"];

Specified by:

getScopeOrDefault in interface 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 [json_name = "scope"];

Specified by:

getScopeOrThrow in interface ScopesOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(java.lang.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 Scopes parseFrom(java.nio.ByteBuffer data)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Scopes parseFrom(java.nio.ByteBuffer data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Scopes parseFrom(com.google.protobuf.ByteString data)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Scopes parseFrom(com.google.protobuf.ByteString data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Scopes parseFrom(byte[] data)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Scopes parseFrom(java.io.InputStream input)
                        throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Scopes parseFrom(java.io.InputStream input,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Scopes parseDelimitedFrom(java.io.InputStream input)
                                 throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Scopes parseDelimitedFrom(java.io.InputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Scopes parseFrom(com.google.protobuf.CodedInputStream input)
                        throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Scopes parseFrom(com.google.protobuf.CodedInputStream input,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public Scopes.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Scopes.Builder newBuilder()

newBuilder

public static Scopes.Builder newBuilder(Scopes prototype)

toBuilder

public Scopes.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Scopes.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static Scopes getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<Scopes> 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.GeneratedMessage

getDefaultInstanceForType

public Scopes getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder