All Implemented Interfaces:


public abstract class ExternalApi.Builder

Builder for ExternalApi.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description
`ExternalApi.Builder()`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`abstract ExternalApi.Builder`	`apiAuth(ApiAuth apiAuth)`	Setter for apiAuth.
`ExternalApi.Builder`	`apiAuth(ApiAuth.Builder apiAuthBuilder)`	Setter for apiAuth builder.
`ExternalApi.Builder`	`clearApiAuth()`	Clears the value of apiAuth field.
`abstract ExternalApi.Builder`	`apiSpec(ApiSpec apiSpec)`	Setter for apiSpec.
`ExternalApi.Builder`	`clearApiSpec()`	Clears the value of apiSpec field.
`ExternalApi.Builder`	`apiSpec(ApiSpec.Known knownType)`	Setter for apiSpec given a known enum.
`ExternalApi.Builder`	`apiSpec(String apiSpec)`	Setter for apiSpec given a string.
`abstract ExternalApi.Builder`	`authConfig(AuthConfig authConfig)`	Setter for authConfig.
`ExternalApi.Builder`	`authConfig(AuthConfig.Builder authConfigBuilder)`	Setter for authConfig builder.
`ExternalApi.Builder`	`clearAuthConfig()`	Clears the value of authConfig field.
`abstract ExternalApi.Builder`	`elasticSearchParams(ExternalApiElasticSearchParams elasticSearchParams)`	Setter for elasticSearchParams.
`ExternalApi.Builder`	`elasticSearchParams(ExternalApiElasticSearchParams.Builder elasticSearchParamsBuilder)`	Setter for elasticSearchParams builder.
`ExternalApi.Builder`	`clearElasticSearchParams()`	Clears the value of elasticSearchParams field.
`abstract ExternalApi.Builder`	`endpoint(String endpoint)`	Setter for endpoint.
`ExternalApi.Builder`	`clearEndpoint()`	Clears the value of endpoint field.
`abstract ExternalApi.Builder`	`simpleSearchParams(ExternalApiSimpleSearchParams simpleSearchParams)`	Setter for simpleSearchParams.
`ExternalApi.Builder`	`simpleSearchParams(ExternalApiSimpleSearchParams.Builder simpleSearchParamsBuilder)`	Setter for simpleSearchParams builder.
`ExternalApi.Builder`	`clearSimpleSearchParams()`	Clears the value of simpleSearchParams field.
`abstract ExternalApi`	`build()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ExternalApi.Builder
```
ExternalApi.Builder()
```
- Method Detail
  - apiAuth
```
 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() 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() ExternalApi.Builder clearApiAuth()
```
    Clears the value of apiAuth field.
  - apiSpec
```
 abstract ExternalApi.Builder apiSpec(ApiSpec apiSpec)
```
    Setter for apiSpec.
    apiSpec: The API spec that the external API implements.
  - clearApiSpec
```
@CanIgnoreReturnValue() ExternalApi.Builder clearApiSpec()
```
    Clears the value of apiSpec field.
  - apiSpec
```
@CanIgnoreReturnValue() ExternalApi.Builder apiSpec(ApiSpec.Known knownType)
```
    Setter for apiSpec given a known enum.
    apiSpec: The API spec that the external API implements.
  - apiSpec
```
@CanIgnoreReturnValue() ExternalApi.Builder apiSpec(String apiSpec)
```
    Setter for apiSpec given a string.
    apiSpec: The API spec that the external API implements.
  - authConfig
```
 abstract ExternalApi.Builder authConfig(AuthConfig authConfig)
```
    Setter for authConfig.
    authConfig: The authentication config to access the API.
  - authConfig
```
@CanIgnoreReturnValue() ExternalApi.Builder authConfig(AuthConfig.Builder authConfigBuilder)
```
    Setter for authConfig builder.
    authConfig: The authentication config to access the API.
  - clearAuthConfig
```
@CanIgnoreReturnValue() ExternalApi.Builder clearAuthConfig()
```
    Clears the value of authConfig field.
  - elasticSearchParams
```
 abstract ExternalApi.Builder elasticSearchParams(ExternalApiElasticSearchParams elasticSearchParams)
```
    Setter for elasticSearchParams.
    elasticSearchParams: Parameters for the elastic search API.
  - elasticSearchParams
```
@CanIgnoreReturnValue() ExternalApi.Builder elasticSearchParams(ExternalApiElasticSearchParams.Builder elasticSearchParamsBuilder)
```
    Setter for elasticSearchParams builder.
    elasticSearchParams: Parameters for the elastic search API.
  - clearElasticSearchParams
```
@CanIgnoreReturnValue() ExternalApi.Builder clearElasticSearchParams()
```
    Clears the value of elasticSearchParams field.
  - endpoint
```
 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() ExternalApi.Builder clearEndpoint()
```
    Clears the value of endpoint field.
  - simpleSearchParams
```
 abstract ExternalApi.Builder simpleSearchParams(ExternalApiSimpleSearchParams simpleSearchParams)
```
    Setter for simpleSearchParams.
    simpleSearchParams: Parameters for the simple search API.
  - simpleSearchParams
```
@CanIgnoreReturnValue() ExternalApi.Builder simpleSearchParams(ExternalApiSimpleSearchParams.Builder simpleSearchParamsBuilder)
```
    Setter for simpleSearchParams builder.
    simpleSearchParams: Parameters for the simple search API.
  - clearSimpleSearchParams
```
@CanIgnoreReturnValue() ExternalApi.Builder clearSimpleSearchParams()
```
    Clears the value of simpleSearchParams field.
  - build
```
 abstract ExternalApi build()
```

Class ExternalApi.Builder

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ExternalApi.Builder

Method Detail

apiAuth

apiAuth

clearApiAuth

apiSpec

clearApiSpec

apiSpec

apiSpec

authConfig

authConfig

clearAuthConfig

elasticSearchParams

elasticSearchParams

clearElasticSearchParams

endpoint

clearEndpoint

simpleSearchParams

simpleSearchParams

clearSimpleSearchParams

build