Interface HTTPAuthSecuritySchemeOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
HTTPAuthSecurityScheme, HTTPAuthSecurityScheme.Builder

@Generated public interface HTTPAuthSecuritySchemeOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Summary

    Modifier and Type
    Method
    Description
    A hint to the client to identify how the bearer token is formatted (e.g., "JWT").
    com.google.protobuf.ByteString
    A hint to the client to identify how the bearer token is formatted (e.g., "JWT").
    An optional description for the security scheme.
    com.google.protobuf.ByteString
    An optional description for the security scheme.
    The name of the HTTP Authentication scheme to be used in the Authorization header, as defined in RFC7235 (e.g., "Bearer").
    com.google.protobuf.ByteString
    The name of the HTTP Authentication scheme to be used in the Authorization header, as defined in RFC7235 (e.g., "Bearer").

    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 Details

    • getDescription

      String getDescription()
       An optional description for the security scheme.
       
      string description = 1;
      Returns:
      The description.
    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       An optional description for the security scheme.
       
      string description = 1;
      Returns:
      The bytes for description.
    • getScheme

      String getScheme()
       The name of the HTTP Authentication scheme to be used in the Authorization header,
       as defined in RFC7235 (e.g., "Bearer").
       This value should be registered in the IANA Authentication Scheme registry.
       
      string scheme = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The scheme.
    • getSchemeBytes

      com.google.protobuf.ByteString getSchemeBytes()
       The name of the HTTP Authentication scheme to be used in the Authorization header,
       as defined in RFC7235 (e.g., "Bearer").
       This value should be registered in the IANA Authentication Scheme registry.
       
      string scheme = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for scheme.
    • getBearerFormat

      String getBearerFormat()
       A hint to the client to identify how the bearer token is formatted (e.g., "JWT").
       Primarily for documentation purposes.
       
      string bearer_format = 3;
      Returns:
      The bearerFormat.
    • getBearerFormatBytes

      com.google.protobuf.ByteString getBearerFormatBytes()
       A hint to the client to identify how the bearer token is formatted (e.g., "JWT").
       Primarily for documentation purposes.
       
      string bearer_format = 3;
      Returns:
      The bytes for bearerFormat.