Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AuthConfigApiKeyConfig

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

Overview

Config for authentication with API key.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1AuthConfigApiKeyConfig

Returns a new instance of GoogleCloudAiplatformV1beta1AuthConfigApiKeyConfig.



1334
1335
1336
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 1334

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

Instance Attribute Details

#api_key_secretString

Required. The name of the SecretManager secret version resource storing the API key. Format: projects/project/secrets/secrete/versions/version`- 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)


1321
1322
1323
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 1321

def api_key_secret
  @api_key_secret
end

#http_element_locationString

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

Returns:

  • (String)


1326
1327
1328
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 1326

def http_element_location
  @http_element_location
end

#nameString

Required. 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)


1332
1333
1334
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 1332

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1339
1340
1341
1342
1343
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 1339

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