Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AuthConfigApiKeyConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1/classes.rb,
lib/google/apis/aiplatform_v1/representations.rb,
lib/google/apis/aiplatform_v1/representations.rb

Overview

Config for authentication with API key.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1AuthConfigApiKeyConfig

Returns a new instance of GoogleCloudAiplatformV1AuthConfigApiKeyConfig.



1729
1730
1731
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 1729

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#api_key_secret ⇒ String

Optional. The name of the SecretManager secret version resource storing the API key. Format: projects/project/secrets/secrete/versions/version`- If bothapi_key_secretandapi_key_stringare specified, this field takes precedence overapi_key_string. - If specified, thesecretmanager.versions. accesspermission should be granted to Vertex AI Extension Service Agent ( https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. Corresponds to the JSON propertyapiKeySecret`

Returns:

  • (String) 


1711
1712
1713
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 1711

def api_key_secret
  @api_key_secret
end

#api_key_string ⇒ String

Optional. The API key to be used in the request directly. Corresponds to the JSON property apiKeyString

Returns:

  • (String) 


1716
1717
1718
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 1716

def api_key_string
  @api_key_string
end

#http_element_location ⇒ String

Optional. The location of the API key. Corresponds to the JSON property httpElementLocation

Returns:

  • (String) 


1721
1722
1723
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 1721

def http_element_location
  @http_element_location
end

#name ⇒ String

Optional. The parameter name of the API key. E.g. If the API request is "https: //example.com/act?api_key=", "api_key" would be the parameter name. Corresponds to the JSON property name

Returns:

  • (String) 


1727
1728
1729
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 1727

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1734
1735
1736
1737
1738
1739
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 1734

def update!(**args)
  @api_key_secret = args[:api_key_secret] if args.key?(:api_key_secret)
  @api_key_string = args[:api_key_string] if args.key?(:api_key_string)
  @http_element_location = args[:http_element_location] if args.key?(:http_element_location)
  @name = args[:name] if args.key?(:name)
end