Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AuthConfigApiKeyConfig
- Inherits:
-
Object
- Object
- Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AuthConfigApiKeyConfig
- 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
-
#api_key_secret ⇒ String
Required.
-
#http_element_location ⇒ String
Required.
-
#name ⇒ String
Required.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1AuthConfigApiKeyConfig
constructor
A new instance of GoogleCloudAiplatformV1beta1AuthConfigApiKeyConfig.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1AuthConfigApiKeyConfig
Returns a new instance of GoogleCloudAiplatformV1beta1AuthConfigApiKeyConfig.
1126 1127 1128 |
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 1126 def initialize(**args) update!(**args) end |
Instance Attribute Details
#api_key_secret ⇒ String
Required. The name of the SecretManager secret version resource storing the
API key. Format: projects/
project/secrets/
secrete/versions/
version`-
If specified, the
secretmanager.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 property
apiKeySecret`
1113 1114 1115 |
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 1113 def api_key_secret @api_key_secret end |
#http_element_location ⇒ String
Required. The location of the API key.
Corresponds to the JSON property httpElementLocation
1118 1119 1120 |
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 1118 def http_element_location @http_element_location end |
#name ⇒ String
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
1124 1125 1126 |
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 1124 def name @name end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1131 1132 1133 1134 1135 |
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 1131 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 |