Package com.google.genai.types

Class ApiKeyConfig.Builder

java.lang.Object
com.google.genai.types.ApiKeyConfig.Builder
Enclosing class:
ApiKeyConfig
public abstract static class ApiKeyConfig.Builder extends Object
Builder for ApiKeyConfig.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • apiKeySecret

      public abstract ApiKeyConfig.Builder apiKeySecret(String apiKeySecret)
      Setter for apiKeySecret.

      apiKeySecret: Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission 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.

    • clearApiKeySecret

      @CanIgnoreReturnValue public ApiKeyConfig.Builder clearApiKeySecret()
      Clears the value of apiKeySecret field.

    • apiKeyString

      public abstract ApiKeyConfig.Builder apiKeyString(String apiKeyString)
      Setter for apiKeyString.

      apiKeyString: Optional. The API key to be used in the request directly.

    • clearApiKeyString

      @CanIgnoreReturnValue public ApiKeyConfig.Builder clearApiKeyString()
      Clears the value of apiKeyString field.

    • httpElementLocation

      public abstract ApiKeyConfig.Builder httpElementLocation(HttpElementLocation httpElementLocation)
      Setter for httpElementLocation.

      httpElementLocation: Optional. The location of the API key.

    • clearHttpElementLocation

      @CanIgnoreReturnValue public ApiKeyConfig.Builder clearHttpElementLocation()
      Clears the value of httpElementLocation field.

    • httpElementLocation

      @CanIgnoreReturnValue public ApiKeyConfig.Builder httpElementLocation(HttpElementLocation.Known knownType)
      Setter for httpElementLocation given a known enum.

      httpElementLocation: Optional. The location of the API key.

    • httpElementLocation

      @CanIgnoreReturnValue public ApiKeyConfig.Builder httpElementLocation(String httpElementLocation)
      Setter for httpElementLocation given a string.

      httpElementLocation: Optional. The location of the API key.

    • name

      public abstract ApiKeyConfig.Builder name(String name)
      Setter for name.

      name: 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.

    • clearName

      @CanIgnoreReturnValue public ApiKeyConfig.Builder clearName()
      Clears the value of name field.

    • build

      public abstract ApiKeyConfig build()