Package grpc.gateway.protoc_gen_openapiv2.options

Class Openapiv2.SecurityScheme.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Openapiv2.SecurityScheme.Builder>
grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.SecurityScheme.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Openapiv2.SecuritySchemeOrBuilder, Cloneable
Enclosing class:
Openapiv2.SecurityScheme
public static final class Openapiv2.SecurityScheme.Builder extends com.google.protobuf.GeneratedMessage.Builder<Openapiv2.SecurityScheme.Builder> 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

  • Method Details

    • 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.Builder<Openapiv2.SecurityScheme.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<Openapiv2.SecurityScheme.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Openapiv2.SecurityScheme.Builder>

    • clear

      public Openapiv2.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.GeneratedMessage.Builder<Openapiv2.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.GeneratedMessage.Builder<Openapiv2.SecurityScheme.Builder>

    • getDefaultInstanceForType

      public Openapiv2.SecurityScheme getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

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

    • buildPartial

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

    • mergeFrom

      public Openapiv2.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<Openapiv2.SecurityScheme.Builder>

    • mergeFrom

      public Openapiv2.SecurityScheme.Builder mergeFrom(Openapiv2.SecurityScheme other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Openapiv2.SecurityScheme.Builder>

    • mergeFrom

      public Openapiv2.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<Openapiv2.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;
      Specified by:
      getTypeValue in interface Openapiv2.SecuritySchemeOrBuilder
      Returns:
      The enum numeric value on the wire for type.

    • setTypeValue

      public Openapiv2.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;
      Parameters:
      value - The enum numeric value on the wire for type to set.
      Returns:
      This builder for chaining.

    • getType

      public 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;
      Specified by:
      getType in interface Openapiv2.SecuritySchemeOrBuilder
      Returns:
      The type.

    • setType

      public Openapiv2.SecurityScheme.Builder setType(Openapiv2.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;
      Parameters:
      value - The type to set.
      Returns:
      This builder for chaining.

    • clearType

      public Openapiv2.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;
      Returns:
      This builder for chaining.

    • getDescription

      public String getDescription()
       A short description for security scheme.
      string description = 2;
      Specified by:
      getDescription in interface Openapiv2.SecuritySchemeOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       A short description for security scheme.
      string description = 2;
      Specified by:
      getDescriptionBytes in interface Openapiv2.SecuritySchemeOrBuilder
      Returns:
      The bytes for description.

    • setDescription

      public Openapiv2.SecurityScheme.Builder setDescription(String value)
       A short description for security scheme.
      string description = 2;
      Parameters:
      value - The description to set.
      Returns:
      This builder for chaining.

    • clearDescription

      public Openapiv2.SecurityScheme.Builder clearDescription()
       A short description for security scheme.
      string description = 2;
      Returns:
      This builder for chaining.

    • setDescriptionBytes

      public Openapiv2.SecurityScheme.Builder setDescriptionBytes(com.google.protobuf.ByteString value)
       A short description for security scheme.
      string description = 2;
      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;
      Specified by:
      getName in interface Openapiv2.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;
      Specified by:
      getNameBytes in interface Openapiv2.SecuritySchemeOrBuilder
      Returns:
      The bytes for name.

    • setName

      public Openapiv2.SecurityScheme.Builder setName(String value)
       The name of the header or query parameter to be used.
 Valid for apiKey.
      string name = 3;
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public Openapiv2.SecurityScheme.Builder clearName()
       The name of the header or query parameter to be used.
 Valid for apiKey.
      string name = 3;
      Returns:
      This builder for chaining.

    • setNameBytes

      public Openapiv2.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;
      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;
      Specified by:
      getInValue in interface Openapiv2.SecuritySchemeOrBuilder
      Returns:
      The enum numeric value on the wire for in.

    • setInValue

      public Openapiv2.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;
      Parameters:
      value - The enum numeric value on the wire for in to set.
      Returns:
      This builder for chaining.

    • getIn

      public 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;
      Specified by:
      getIn in interface Openapiv2.SecuritySchemeOrBuilder
      Returns:
      The in.

    • setIn

      public Openapiv2.SecurityScheme.Builder setIn(Openapiv2.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;
      Parameters:
      value - The in to set.
      Returns:
      This builder for chaining.

    • clearIn

      public Openapiv2.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;
      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;
      Specified by:
      getFlowValue in interface Openapiv2.SecuritySchemeOrBuilder
      Returns:
      The enum numeric value on the wire for flow.

    • setFlowValue

      public Openapiv2.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;
      Parameters:
      value - The enum numeric value on the wire for flow to set.
      Returns:
      This builder for chaining.

    • getFlow

      public 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;
      Specified by:
      getFlow in interface Openapiv2.SecuritySchemeOrBuilder
      Returns:
      The flow.

    • setFlow

      public Openapiv2.SecurityScheme.Builder setFlow(Openapiv2.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;
      Parameters:
      value - The flow to set.
      Returns:
      This builder for chaining.

    • clearFlow

      public Openapiv2.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;
      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;
      Specified by:
      getAuthorizationUrl in interface Openapiv2.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;
      Specified by:
      getAuthorizationUrlBytes in interface Openapiv2.SecuritySchemeOrBuilder
      Returns:
      The bytes for authorizationUrl.

    • setAuthorizationUrl

      public Openapiv2.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;
      Parameters:
      value - The authorizationUrl to set.
      Returns:
      This builder for chaining.

    • clearAuthorizationUrl

      public Openapiv2.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;
      Returns:
      This builder for chaining.

    • setAuthorizationUrlBytes

      public Openapiv2.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;
      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;
      Specified by:
      getTokenUrl in interface Openapiv2.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;
      Specified by:
      getTokenUrlBytes in interface Openapiv2.SecuritySchemeOrBuilder
      Returns:
      The bytes for tokenUrl.

    • setTokenUrl

      public Openapiv2.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;
      Parameters:
      value - The tokenUrl to set.
      Returns:
      This builder for chaining.

    • clearTokenUrl

      public Openapiv2.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;
      Returns:
      This builder for chaining.

    • setTokenUrlBytes

      public Openapiv2.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;
      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;
      Specified by:
      hasScopes in interface Openapiv2.SecuritySchemeOrBuilder
      Returns:
      Whether the scopes field is set.

    • getScopes

      public Openapiv2.Scopes getScopes()
       The available scopes for the OAuth2 security scheme.
 Valid for oauth2.
      .grpc.gateway.protoc_gen_openapiv2.options.Scopes scopes = 8;
      Specified by:
      getScopes in interface Openapiv2.SecuritySchemeOrBuilder
      Returns:
      The scopes.

    • setScopes

      public Openapiv2.SecurityScheme.Builder setScopes(Openapiv2.Scopes value)
       The available scopes for the OAuth2 security scheme.
 Valid for oauth2.
      .grpc.gateway.protoc_gen_openapiv2.options.Scopes scopes = 8;

    • setScopes

      public Openapiv2.SecurityScheme.Builder setScopes(Openapiv2.Scopes.Builder builderForValue)
       The available scopes for the OAuth2 security scheme.
 Valid for oauth2.
      .grpc.gateway.protoc_gen_openapiv2.options.Scopes scopes = 8;

    • mergeScopes

      public Openapiv2.SecurityScheme.Builder mergeScopes(Openapiv2.Scopes value)
       The available scopes for the OAuth2 security scheme.
 Valid for oauth2.
      .grpc.gateway.protoc_gen_openapiv2.options.Scopes scopes = 8;

    • clearScopes

      public Openapiv2.SecurityScheme.Builder clearScopes()
       The available scopes for the OAuth2 security scheme.
 Valid for oauth2.
      .grpc.gateway.protoc_gen_openapiv2.options.Scopes scopes = 8;

    • getScopesBuilder

      public Openapiv2.Scopes.Builder getScopesBuilder()
       The available scopes for the OAuth2 security scheme.
 Valid for oauth2.
      .grpc.gateway.protoc_gen_openapiv2.options.Scopes scopes = 8;

    • getScopesOrBuilder

      public Openapiv2.ScopesOrBuilder getScopesOrBuilder()
       The available scopes for the OAuth2 security scheme.
 Valid for oauth2.
      .grpc.gateway.protoc_gen_openapiv2.options.Scopes scopes = 8;
      Specified by:
      getScopesOrBuilder in interface Openapiv2.SecuritySchemeOrBuilder

    • getExtensionsCount

      public int getExtensionsCount()
      Description copied from interface: Openapiv2.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;
      Specified by:
      getExtensionsCount in interface Openapiv2.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;
      Specified by:
      containsExtensions in interface Openapiv2.SecuritySchemeOrBuilder

    • getExtensions

      @Deprecated public Map<String,com.google.protobuf.Value> getExtensions()
      Deprecated.
      Use getExtensionsMap() instead.
      Specified by:
      getExtensions in interface Openapiv2.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;
      Specified by:
      getExtensionsMap in interface Openapiv2.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;
      Specified by:
      getExtensionsOrDefault in interface Openapiv2.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;
      Specified by:
      getExtensionsOrThrow in interface Openapiv2.SecuritySchemeOrBuilder

    • clearExtensions

      public Openapiv2.SecurityScheme.Builder clearExtensions()

    • removeExtensions

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

    • getMutableExtensions

      @Deprecated public Map<String,com.google.protobuf.Value> getMutableExtensions()
      Deprecated.
      Use alternate mutation accessors instead.

    • putExtensions

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

    • putAllExtensions

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

    • 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;