Package grpc.gateway.protoc_gen_openapiv2.options

Interface Openapiv2.SecuritySchemeOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method 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.
      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.
      java.lang.String getDescription()
      A short description for security scheme.
      com.google.protobuf.ByteString getDescriptionBytes()
      A short description for security scheme.
      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.
      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.
      Openapiv2.Scopes getScopes()
      The available scopes for the OAuth2 security scheme.
      Openapiv2.ScopesOrBuilder getScopesOrBuilder()
      The available scopes for the OAuth2 security scheme.
      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.
      boolean hasScopes()
      The available scopes for the OAuth2 security scheme.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • getTypeValue

        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;
        Returns:
        The enum numeric value on the wire for type.

      • getType

        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;
        Returns:
        The type.

      • getDescription

        java.lang.String getDescription()
         A short description for security scheme.
        string description = 2;
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         A short description for security scheme.
        string description = 2;
        Returns:
        The bytes for description.

      • getName

        java.lang.String getName()
         The name of the header or query parameter to be used.
 Valid for apiKey.
        string name = 3;
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         The name of the header or query parameter to be used.
 Valid for apiKey.
        string name = 3;
        Returns:
        The bytes for name.

      • getInValue

        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;
        Returns:
        The enum numeric value on the wire for in.

      • getIn

        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;
        Returns:
        The in.

      • getFlowValue

        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;
        Returns:
        The enum numeric value on the wire for flow.

      • getFlow

        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;
        Returns:
        The flow.

      • getAuthorizationUrl

        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;
        Returns:
        The authorizationUrl.

      • getAuthorizationUrlBytes

        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;
        Returns:
        The bytes for authorizationUrl.

      • getTokenUrl

        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;
        Returns:
        The tokenUrl.

      • getTokenUrlBytes

        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;
        Returns:
        The bytes for tokenUrl.

      • hasScopes

        boolean hasScopes()
         The available scopes for the OAuth2 security scheme.
 Valid for oauth2.
        .grpc.gateway.protoc_gen_openapiv2.options.Scopes scopes = 8;
        Returns:
        Whether the scopes field is set.

      • getScopes

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

      • getScopesOrBuilder

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

      • getExtensionsCount

        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.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
        map<string, .google.protobuf.Value> extensions = 9;

      • containsExtensions

        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.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
        map<string, .google.protobuf.Value> extensions = 9;

      • getExtensions

        @Deprecated
java.util.Map<java.lang.String,​com.google.protobuf.Value> getExtensions()
        Deprecated.
        Use getExtensionsMap() instead.

      • getExtensionsMap

        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.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
        map<string, .google.protobuf.Value> extensions = 9;

      • getExtensionsOrDefault

        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.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
        map<string, .google.protobuf.Value> extensions = 9;

      • getExtensionsOrThrow

        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.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
        map<string, .google.protobuf.Value> extensions = 9;