Gemini Enterprise for Customer Experience V1 API - Class Google::Cloud::Ces::V1::ApiKeyConfig (v0.1.0)

Reference documentation and code samples for the Gemini Enterprise for Customer Experience V1 API class Google::Cloud::Ces::V1::ApiKeyConfig.

Configurations for authentication with API key.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#api_key_secret_version

def api_key_secret_version() -> ::String
Returns
  • (::String) — Required. The name of the SecretManager secret version resource storing the API key. Format: projects/{project}/secrets/{secret}/versions/{version}

    Note: You should grant roles/secretmanager.secretAccessor role to the CES service agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

#api_key_secret_version=

def api_key_secret_version=(value) -> ::String
Parameter
  • value (::String) — Required. The name of the SecretManager secret version resource storing the API key. Format: projects/{project}/secrets/{secret}/versions/{version}

    Note: You should grant roles/secretmanager.secretAccessor role to the CES service agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

Returns
  • (::String) — Required. The name of the SecretManager secret version resource storing the API key. Format: projects/{project}/secrets/{secret}/versions/{version}

    Note: You should grant roles/secretmanager.secretAccessor role to the CES service agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

#key_name

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

#key_name=

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

#request_location

def request_location() -> ::Google::Cloud::Ces::V1::ApiKeyConfig::RequestLocation
Returns

#request_location=

def request_location=(value) -> ::Google::Cloud::Ces::V1::ApiKeyConfig::RequestLocation
Parameter
Returns