Interface AuthConfig.ApiKeyConfigOrBuilder (0.28.0)

public static interface AuthConfig.ApiKeyConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getApiKey()

public abstract Secret getApiKey()

Required. The name of the SecretManager secret version resource storing the API key. Format: projects/{project}/secrets/{secrete}/versions/{version}. The secretmanager.versions.access permission should be granted to the service account accessing the secret.

.google.cloud.apihub.v1.Secret api_key = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Secret

The apiKey.

getApiKeyOrBuilder()

public abstract SecretOrBuilder getApiKeyOrBuilder()

Required. The name of the SecretManager secret version resource storing the API key. Format: projects/{project}/secrets/{secrete}/versions/{version}. The secretmanager.versions.access permission should be granted to the service account accessing the secret.

.google.cloud.apihub.v1.Secret api_key = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SecretOrBuilder

getHttpElementLocation()

public abstract AuthConfig.ApiKeyConfig.HttpElementLocation getHttpElementLocation()

Required. The location of the API key. The default value is QUERY.

.google.cloud.apihub.v1.AuthConfig.ApiKeyConfig.HttpElementLocation http_element_location = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AuthConfig.ApiKeyConfig.HttpElementLocation

The httpElementLocation.

getHttpElementLocationValue()

public abstract int getHttpElementLocationValue()

Required. The location of the API key. The default value is QUERY.

.google.cloud.apihub.v1.AuthConfig.ApiKeyConfig.HttpElementLocation http_element_location = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for httpElementLocation.

getName()

public abstract String getName()

Required. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=<API KEY>", "api_key" would be the parameter name.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Required. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=<API KEY>", "api_key" would be the parameter name.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for name.

hasApiKey()

public abstract boolean hasApiKey()

Required. The name of the SecretManager secret version resource storing the API key. Format: projects/{project}/secrets/{secrete}/versions/{version}. The secretmanager.versions.access permission should be granted to the service account accessing the secret.

.google.cloud.apihub.v1.Secret api_key = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the apiKey field is set.