API hub V1 API - Class Google::Cloud::ApiHub::V1::AuthConfig::ApiKeyConfig (v0.6.0)

Reference documentation and code samples for the API hub V1 API class Google::Cloud::ApiHub::V1::AuthConfig::ApiKeyConfig.

Config for authentication with API key.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#api_key

def api_key() -> ::Google::Cloud::ApiHub::V1::Secret
Returns
  • (::Google::Cloud::ApiHub::V1::Secret) — 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.

#api_key=

def api_key=(value) -> ::Google::Cloud::ApiHub::V1::Secret
Parameter
  • value (::Google::Cloud::ApiHub::V1::Secret) — 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.
Returns
  • (::Google::Cloud::ApiHub::V1::Secret) — 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.

#http_element_location

def http_element_location() -> ::Google::Cloud::ApiHub::V1::AuthConfig::ApiKeyConfig::HttpElementLocation
Returns

#http_element_location=

def http_element_location=(value) -> ::Google::Cloud::ApiHub::V1::AuthConfig::ApiKeyConfig::HttpElementLocation
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::String) — Required. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Required. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=
Returns
  • (::String) — Required. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=