Interface APIKeySecuritySchemeOrBuilder

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

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

    Modifier and Type
    Method
    Description
    An optional description for the security scheme.
    com.google.protobuf.ByteString
    An optional description for the security scheme.
    The location of the API key.
    com.google.protobuf.ByteString
    The location of the API key.
    The name of the header, query, or cookie parameter to be used.
    com.google.protobuf.ByteString
    The name of the header, query, or cookie parameter to be used.

    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.
    • getLocation

      String getLocation()
       The location of the API key. Valid values are "query", "header", or "cookie".
       
      string location = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The location.
    • getLocationBytes

      com.google.protobuf.ByteString getLocationBytes()
       The location of the API key. Valid values are "query", "header", or "cookie".
       
      string location = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for location.
    • getName

      String getName()
       The name of the header, query, or cookie parameter to be used.
       
      string name = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The name.
    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       The name of the header, query, or cookie parameter to be used.
       
      string name = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for name.