Package com.google.genai.types

Class ExternalApi.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • apiAuth

      public abstract ExternalApi.Builder apiAuth(ApiAuth apiAuth)
      Setter for apiAuth.

      apiAuth: The authentication config to access the API. Deprecated. Please use auth_config instead.

    • apiAuth

      @CanIgnoreReturnValue public ExternalApi.Builder apiAuth(ApiAuth.Builder apiAuthBuilder)
      Setter for apiAuth builder.

      apiAuth: The authentication config to access the API. Deprecated. Please use auth_config instead.

    • clearApiAuth

      @CanIgnoreReturnValue public ExternalApi.Builder clearApiAuth()
      Clears the value of apiAuth field.

    • apiSpec

      public abstract ExternalApi.Builder apiSpec(ApiSpec apiSpec)
      Setter for apiSpec.

      apiSpec: The API spec that the external API implements.

    • clearApiSpec

      @CanIgnoreReturnValue public ExternalApi.Builder clearApiSpec()
      Clears the value of apiSpec field.

    • apiSpec

      @CanIgnoreReturnValue public ExternalApi.Builder apiSpec(ApiSpec.Known knownType)
      Setter for apiSpec given a known enum.

      apiSpec: The API spec that the external API implements.

    • apiSpec

      @CanIgnoreReturnValue public ExternalApi.Builder apiSpec(String apiSpec)
      Setter for apiSpec given a string.

      apiSpec: The API spec that the external API implements.

    • authConfig

      public abstract ExternalApi.Builder authConfig(AuthConfig authConfig)
      Setter for authConfig.

      authConfig: The authentication config to access the API.

    • authConfig

      @CanIgnoreReturnValue public ExternalApi.Builder authConfig(AuthConfig.Builder authConfigBuilder)
      Setter for authConfig builder.

      authConfig: The authentication config to access the API.

    • clearAuthConfig

      @CanIgnoreReturnValue public ExternalApi.Builder clearAuthConfig()
      Clears the value of authConfig field.

    • elasticSearchParams

      public abstract ExternalApi.Builder elasticSearchParams(ExternalApiElasticSearchParams elasticSearchParams)
      Setter for elasticSearchParams.

      elasticSearchParams: Parameters for the elastic search API.

    • elasticSearchParams

      @CanIgnoreReturnValue public ExternalApi.Builder elasticSearchParams(ExternalApiElasticSearchParams.Builder elasticSearchParamsBuilder)
      Setter for elasticSearchParams builder.

      elasticSearchParams: Parameters for the elastic search API.

    • clearElasticSearchParams

      @CanIgnoreReturnValue public ExternalApi.Builder clearElasticSearchParams()
      Clears the value of elasticSearchParams field.

    • endpoint

      public abstract ExternalApi.Builder endpoint(String endpoint)
      Setter for endpoint.

      endpoint: The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search

    • clearEndpoint

      @CanIgnoreReturnValue public ExternalApi.Builder clearEndpoint()
      Clears the value of endpoint field.

    • simpleSearchParams

      public abstract ExternalApi.Builder simpleSearchParams(ExternalApiSimpleSearchParams simpleSearchParams)
      Setter for simpleSearchParams.

      simpleSearchParams: Parameters for the simple search API.

    • simpleSearchParams

      @CanIgnoreReturnValue public ExternalApi.Builder simpleSearchParams(ExternalApiSimpleSearchParams.Builder simpleSearchParamsBuilder)
      Setter for simpleSearchParams builder.

      simpleSearchParams: Parameters for the simple search API.

    • clearSimpleSearchParams

      @CanIgnoreReturnValue public ExternalApi.Builder clearSimpleSearchParams()
      Clears the value of simpleSearchParams field.

    • build

      public abstract ExternalApi build()