Interface APIKeySecuritySchemeOrBuilder (0.27.0)

0.27.0 (latest) 0.23.0 0.22.0 0.21.0 0.19.0 0.16.0 0.15.0 0.13.0 0.11.0 0.10.0 0.9.0 0.8.0 0.6.0 0.4.0 0.3.0 0.2.0 0.1.0

public interface APIKeySecuritySchemeOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDescription()

public abstract String getDescription()

Optional. Description of this security scheme.

string description = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Optional. Description of this security scheme.

string description = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for description.

getLocation()

public abstract String getLocation()

Optional. Location of the API key, valid values are "query", "header", or "cookie".

string location = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The location.

getLocationBytes()

public abstract ByteString getLocationBytes()

Optional. Location of the API key, valid values are "query", "header", or "cookie".

string location = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for location.

getName()

public abstract String getName()

Optional. Name of the header, query or cookie parameter to be used.

string name = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Optional. Name of the header, query or cookie parameter to be used.

string name = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for name.