com.grpc.gateway.protoc_gen_openapiv2.options

Class SecurityScheme.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<SecurityScheme.Builder>

com.grpc.gateway.protoc_gen_openapiv2.options.SecurityScheme.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SecuritySchemeOrBuilder, Cloneable

Enclosing class:

SecurityScheme

public static final class SecurityScheme.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<SecurityScheme.Builder>
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

Method Summary

Modifier and Type	Method and Description
SecurityScheme.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
SecurityScheme	build()
SecurityScheme	buildPartial()
SecurityScheme.Builder	clear()
SecurityScheme.Builder	clearAuthorizationUrl() The authorization URL to be used for this flow.
SecurityScheme.Builder	clearDescription() A short description for security scheme.
SecurityScheme.Builder	clearExtensions()
SecurityScheme.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
SecurityScheme.Builder	clearFlow() The flow used by the OAuth2 security scheme.
SecurityScheme.Builder	clearIn() The location of the API key.
SecurityScheme.Builder	clearName() The name of the header or query parameter to be used.
SecurityScheme.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
SecurityScheme.Builder	clearScopes() The available scopes for the OAuth2 security scheme.
SecurityScheme.Builder	clearTokenUrl() The token URL to be used for this flow.
SecurityScheme.Builder	clearType() The type of the security scheme.
SecurityScheme.Builder	clone()
boolean	containsExtensions(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.
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.
SecurityScheme	getDefaultInstanceForType()
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()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
Map<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.
Map<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(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(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.
Map<String,com.google.protobuf.Value>	getMutableExtensions() Deprecated.
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.
Scopes	getScopes() The available scopes for the OAuth2 security scheme.
Scopes.Builder	getScopesBuilder() The available scopes for the OAuth2 security scheme.
ScopesOrBuilder	getScopesOrBuilder() The available scopes for the OAuth2 security scheme.
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.
boolean	hasScopes() The available scopes for the OAuth2 security scheme.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMapFieldReflection(int number)
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMutableMapFieldReflection(int number)
boolean	isInitialized()
SecurityScheme.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
SecurityScheme.Builder	mergeFrom(com.google.protobuf.Message other)
SecurityScheme.Builder	mergeFrom(SecurityScheme other)
SecurityScheme.Builder	mergeScopes(Scopes value) The available scopes for the OAuth2 security scheme.
SecurityScheme.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
SecurityScheme.Builder	putAllExtensions(Map<String,com.google.protobuf.Value> values) 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.Builder	putExtensions(String key, com.google.protobuf.Value value) 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.Builder	putExtensionsBuilderIfAbsent(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.Builder	removeExtensions(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.Builder	setAuthorizationUrl(String value) The authorization URL to be used for this flow.
SecurityScheme.Builder	setAuthorizationUrlBytes(com.google.protobuf.ByteString value) The authorization URL to be used for this flow.
SecurityScheme.Builder	setDescription(String value) A short description for security scheme.
SecurityScheme.Builder	setDescriptionBytes(com.google.protobuf.ByteString value) A short description for security scheme.
SecurityScheme.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
SecurityScheme.Builder	setFlow(SecurityScheme.Flow value) The flow used by the OAuth2 security scheme.
SecurityScheme.Builder	setFlowValue(int value) The flow used by the OAuth2 security scheme.
SecurityScheme.Builder	setIn(SecurityScheme.In value) The location of the API key.
SecurityScheme.Builder	setInValue(int value) The location of the API key.
SecurityScheme.Builder	setName(String value) The name of the header or query parameter to be used.
SecurityScheme.Builder	setNameBytes(com.google.protobuf.ByteString value) The name of the header or query parameter to be used.
SecurityScheme.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
SecurityScheme.Builder	setScopes(Scopes.Builder builderForValue) The available scopes for the OAuth2 security scheme.
SecurityScheme.Builder	setScopes(Scopes value) The available scopes for the OAuth2 security scheme.
SecurityScheme.Builder	setTokenUrl(String value) The token URL to be used for this flow.
SecurityScheme.Builder	setTokenUrlBytes(com.google.protobuf.ByteString value) The token URL to be used for this flow.
SecurityScheme.Builder	setType(SecurityScheme.Type value) The type of the security scheme.
SecurityScheme.Builder	setTypeValue(int value) The type of the security scheme.
SecurityScheme.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

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.GeneratedMessageV3.Builder<SecurityScheme.Builder>

internalGetMutableMapFieldReflection

protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)

Overrides:

internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityScheme.Builder>

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityScheme.Builder>

clear

public SecurityScheme.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityScheme.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityScheme.Builder>

getDefaultInstanceForType

public SecurityScheme getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public SecurityScheme build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public SecurityScheme buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public SecurityScheme.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityScheme.Builder>

setField

public SecurityScheme.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityScheme.Builder>

clearField

public SecurityScheme.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityScheme.Builder>

clearOneof

public SecurityScheme.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityScheme.Builder>

setRepeatedField

public SecurityScheme.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               int index,
                                               Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityScheme.Builder>

addRepeatedField

public SecurityScheme.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityScheme.Builder>

mergeFrom

public SecurityScheme.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SecurityScheme.Builder>

mergeFrom

public SecurityScheme.Builder mergeFrom(SecurityScheme other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityScheme.Builder>

mergeFrom

public SecurityScheme.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SecurityScheme.Builder>

Throws:

IOException

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.

setTypeValue

public SecurityScheme.Builder setTypeValue(int value)

 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"];

Parameters:

value - The enum numeric value on the wire for type to set.

Returns:

This builder for chaining.

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.

setType

public SecurityScheme.Builder setType(SecurityScheme.Type value)

 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"];

Parameters:

value - The type to set.

Returns:

This builder for chaining.

clearType

public SecurityScheme.Builder clearType()

 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"];

Returns:

This builder for chaining.

getDescription

public 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.

setDescription

public SecurityScheme.Builder setDescription(String value)

 A short description for security scheme.
 

string description = 2 [json_name = "description"];

Parameters:

value - The description to set.

Returns:

This builder for chaining.

clearDescription

public SecurityScheme.Builder clearDescription()

 A short description for security scheme.
 

string description = 2 [json_name = "description"];

Returns:

This builder for chaining.

setDescriptionBytes

public SecurityScheme.Builder setDescriptionBytes(com.google.protobuf.ByteString value)

 A short description for security scheme.
 

string description = 2 [json_name = "description"];

Parameters:

value - The bytes for description to set.

Returns:

This builder for chaining.

getName

public 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.

setName

public SecurityScheme.Builder setName(String value)

 The name of the header or query parameter to be used.
 Valid for apiKey.
 

string name = 3 [json_name = "name"];

Parameters:

value - The name to set.

Returns:

This builder for chaining.

clearName

public SecurityScheme.Builder clearName()

 The name of the header or query parameter to be used.
 Valid for apiKey.
 

string name = 3 [json_name = "name"];

Returns:

This builder for chaining.

setNameBytes

public SecurityScheme.Builder setNameBytes(com.google.protobuf.ByteString value)

 The name of the header or query parameter to be used.
 Valid for apiKey.
 

string name = 3 [json_name = "name"];

Parameters:

value - The bytes for name to set.

Returns:

This builder for chaining.

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.

setInValue

public SecurityScheme.Builder setInValue(int value)

 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"];

Parameters:

value - The enum numeric value on the wire for in to set.

Returns:

This builder for chaining.

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.

setIn

public SecurityScheme.Builder setIn(SecurityScheme.In value)

 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"];

Parameters:

value - The in to set.

Returns:

This builder for chaining.

clearIn

public SecurityScheme.Builder clearIn()

 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"];

Returns:

This builder for chaining.

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.

setFlowValue

public SecurityScheme.Builder setFlowValue(int value)

 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"];

Parameters:

value - The enum numeric value on the wire for flow to set.

Returns:

This builder for chaining.

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.

setFlow

public SecurityScheme.Builder setFlow(SecurityScheme.Flow value)

 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"];

Parameters:

value - The flow to set.

Returns:

This builder for chaining.

clearFlow

public SecurityScheme.Builder clearFlow()

 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"];

Returns:

This builder for chaining.

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 [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.

setAuthorizationUrl

public SecurityScheme.Builder setAuthorizationUrl(String value)

 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"];

Parameters:

value - The authorizationUrl to set.

Returns:

This builder for chaining.

clearAuthorizationUrl

public SecurityScheme.Builder clearAuthorizationUrl()

 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"];

Returns:

This builder for chaining.

setAuthorizationUrlBytes

public SecurityScheme.Builder setAuthorizationUrlBytes(com.google.protobuf.ByteString value)

 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"];

Parameters:

value - The bytes for authorizationUrl to set.

Returns:

This builder for chaining.

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 [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.

setTokenUrl

public SecurityScheme.Builder setTokenUrl(String value)

 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"];

Parameters:

value - The tokenUrl to set.

Returns:

This builder for chaining.

clearTokenUrl

public SecurityScheme.Builder clearTokenUrl()

 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"];

Returns:

This builder for chaining.

setTokenUrlBytes

public SecurityScheme.Builder setTokenUrlBytes(com.google.protobuf.ByteString value)

 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"];

Parameters:

value - The bytes for tokenUrl to set.

Returns:

This builder for chaining.

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.

setScopes

public SecurityScheme.Builder setScopes(Scopes value)

 The available scopes for the OAuth2 security scheme.
 Valid for oauth2.
 

.grpc.gateway.protoc_gen_openapiv2.options.Scopes scopes = 8 [json_name = "scopes"];

setScopes

public SecurityScheme.Builder setScopes(Scopes.Builder builderForValue)

 The available scopes for the OAuth2 security scheme.
 Valid for oauth2.
 

.grpc.gateway.protoc_gen_openapiv2.options.Scopes scopes = 8 [json_name = "scopes"];

mergeScopes

public SecurityScheme.Builder mergeScopes(Scopes value)

 The available scopes for the OAuth2 security scheme.
 Valid for oauth2.
 

.grpc.gateway.protoc_gen_openapiv2.options.Scopes scopes = 8 [json_name = "scopes"];

clearScopes

public SecurityScheme.Builder clearScopes()

 The available scopes for the OAuth2 security scheme.
 Valid for oauth2.
 

.grpc.gateway.protoc_gen_openapiv2.options.Scopes scopes = 8 [json_name = "scopes"];

getScopesBuilder

public Scopes.Builder getScopesBuilder()

 The available scopes for the OAuth2 security scheme.
 Valid for oauth2.
 

.grpc.gateway.protoc_gen_openapiv2.options.Scopes scopes = 8 [json_name = "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

getExtensionsCount

public int getExtensionsCount()

Description copied from interface: SecuritySchemeOrBuilder

 Custom properties that start with "x-" such as "x-foo" used to describe
 extra functionality that is not covered by the standard OpenAPI Specification.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
 

map<string, .google.protobuf.Value> extensions = 9 [json_name = "extensions"];

Specified by:

getExtensionsCount in interface SecuritySchemeOrBuilder

containsExtensions

public boolean containsExtensions(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.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
 

map<string, .google.protobuf.Value> extensions = 9 [json_name = "extensions"];

Specified by:

containsExtensions in interface SecuritySchemeOrBuilder

getExtensions

@Deprecated
public Map<String,com.google.protobuf.Value> getExtensions()

Deprecated.

Use getExtensionsMap() instead.

Specified by:

getExtensions in interface SecuritySchemeOrBuilder

getExtensionsMap

public Map<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.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
 

map<string, .google.protobuf.Value> extensions = 9 [json_name = "extensions"];

Specified by:

getExtensionsMap in interface SecuritySchemeOrBuilder

getExtensionsOrDefault

public com.google.protobuf.Value getExtensionsOrDefault(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.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
 

map<string, .google.protobuf.Value> extensions = 9 [json_name = "extensions"];

Specified by:

getExtensionsOrDefault in interface SecuritySchemeOrBuilder

getExtensionsOrThrow

public com.google.protobuf.Value getExtensionsOrThrow(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.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
 

map<string, .google.protobuf.Value> extensions = 9 [json_name = "extensions"];

Specified by:

getExtensionsOrThrow in interface SecuritySchemeOrBuilder

clearExtensions

public SecurityScheme.Builder clearExtensions()

removeExtensions

public SecurityScheme.Builder removeExtensions(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.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
 

map<string, .google.protobuf.Value> extensions = 9 [json_name = "extensions"];

getMutableExtensions

@Deprecated
public Map<String,com.google.protobuf.Value> getMutableExtensions()

Deprecated.

Use alternate mutation accessors instead.

putExtensions

public SecurityScheme.Builder putExtensions(String key,
                                            com.google.protobuf.Value value)

 Custom properties that start with "x-" such as "x-foo" used to describe
 extra functionality that is not covered by the standard OpenAPI Specification.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
 

map<string, .google.protobuf.Value> extensions = 9 [json_name = "extensions"];

putAllExtensions

public SecurityScheme.Builder putAllExtensions(Map<String,com.google.protobuf.Value> values)

 Custom properties that start with "x-" such as "x-foo" used to describe
 extra functionality that is not covered by the standard OpenAPI Specification.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
 

map<string, .google.protobuf.Value> extensions = 9 [json_name = "extensions"];

putExtensionsBuilderIfAbsent

public com.google.protobuf.Value.Builder putExtensionsBuilderIfAbsent(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.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
 

map<string, .google.protobuf.Value> extensions = 9 [json_name = "extensions"];

setUnknownFields

public final SecurityScheme.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityScheme.Builder>

mergeUnknownFields

public final SecurityScheme.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SecurityScheme.Builder>