java.lang.Object
- oracle.pg.rdbms.AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder

Enclosing class:: AdbGraphClientConfiguration

public static class AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder
extends java.lang.Object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder`	`brokerBaseUrl(java.lang.String brokerBaseUrl)`	Set the broker base URL to use.
`AdbGraphClientConfiguration`	`build()`
`AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder`	`database(java.lang.String database)`	The Autonomous Database name.
`AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder`	`databaseOcid(java.lang.String databaseOcid)`	The OCID of the Autonomous Database.
`AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder`	`dataStudioApiVersion(java.lang.String dataStudioApiVersion)`	The API version of the Data Studio REST endpoints to use.
`AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder`	`endpoint(java.lang.String endpoint)`	ADB Graph endpoint URL.
`AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder`	`executorService(java.util.concurrent.ExecutorService executorService)`	The `ExecutorService` this client should use for background polling threads.
`AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder`	`graphStudioApiVersion(java.lang.String graphStudioApiVersion)`	The API version of the Graph Studio REST endpoints to use.
`AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder`	`graphStudioBaseUrl(java.lang.String graphStudioBaseUrl)`	Set the Graph Studio base URL to use.
`AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder`	`httpClient(org.apache.hc.client5.http.classic.HttpClient httpClient)`	The Apache `HttpClient` object to use for HTTP requests.
`AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder`	`jobPollInterval(long jobPollInterval)`	The time interval to use when polling the server for job updates.
`AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder`	`jobPollIntervalTimeUnit(java.util.concurrent.TimeUnit jobPollIntervalTimeUnit)`	The time unit for the `jobPollInterval(long)` time value.
`AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder`	`password(java.lang.String password)`	The Database password to use for login.
`AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder`	`pgxBaseUrl(java.lang.String pgxBaseUrl)`	Set the PGX base URL to use.
`AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder`	`refreshTimeBeforeTokenExpiry(int refreshTimeBeforeTokenExpiry)`	The time to refresh the authentication token automatically before it expires.
`AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder`	`refreshTimeBeforeTokenExpiryTimeUnit(java.util.concurrent.TimeUnit refreshTimeBeforeTokenExpiryTimeUnit)`	The time unit of the `refreshTimeBeforeTokenExpiry(int)` time value.
`AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder`	`tenancyOcid(java.lang.String tenancyOcid)`	The OCID of the tenancy the Autonomous Database belongs to.
`java.lang.String`	`toString()`
`AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder`	`username(java.lang.String username)`	The Database username to use for login.

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

- Method Detail
  - endpoint
```
public AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder endpoint(java.lang.String endpoint)
```
    ADB Graph endpoint URL. Can be obtained from the details page of the Autonomous Database in the OCI console. Mandatory configuration.
    
    Returns:
    
    this.
  - database
```
public AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder database(java.lang.String database)
```
    The Autonomous Database name. Note: this is *not* the display name, but the actual database name. Can be obtained from the details page of the Autonomous Database in the OCI console.
    
    Returns:
    
    this.
  - username
```
public AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder username(java.lang.String username)
```
    The Database username to use for login. Mandatory configuration.
    
    Returns:
    
    this.
  - password
```
public AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder password(java.lang.String password)
```
    The Database password to use for login. Mandatory configuration.
    
    Returns:
    
    this.
  - tenancyOcid
```
public AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder tenancyOcid(java.lang.String tenancyOcid)
```
    The OCID of the tenancy the Autonomous Database belongs to. Can be obtained from the tenancy details page in the OCI console. Mandatory configuration.
    
    Returns:
    
    this.
  - databaseOcid
```
public AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder databaseOcid(java.lang.String databaseOcid)
```
    The OCID of the Autonomous Database. Can be obtained from the details page of the Autonomous Database in the OCI console. Mandatory configuration.
    
    Returns:
    
    this.
  - httpClient
```
public AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder httpClient(org.apache.hc.client5.http.classic.HttpClient httpClient)
```
    The Apache HttpClient object to use for HTTP requests. Optional configuration. If not set, then HttpClients.createDefault() will be used.
    
    Returns:
    
    this.
  - refreshTimeBeforeTokenExpiry
```
public AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder refreshTimeBeforeTokenExpiry(int refreshTimeBeforeTokenExpiry)
```
    The time to refresh the authentication token automatically before it expires. The unit of this time value can be specified via the refreshTimeBeforeTokenExpiryTimeUnit(java.util.concurrent.TimeUnit) configuration. Optional configuration. If not set, then GraphServer.DEFAULT_TIME_BEFORE_EXPIRY will be used.
    
    Returns:
    
    this.
  - refreshTimeBeforeTokenExpiryTimeUnit
```
public AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder refreshTimeBeforeTokenExpiryTimeUnit(java.util.concurrent.TimeUnit refreshTimeBeforeTokenExpiryTimeUnit)
```
    The time unit of the refreshTimeBeforeTokenExpiry(int) time value. Optional configuration. If not set, then AdbGraphClientConfiguration.DEFAULT_REFRESH_TIME_BEFORE_TOKEN_EXPIRY_TIME_UNIT will be used.
    
    Returns:
    
    this.
  - executorService
```
public AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder executorService(java.util.concurrent.ExecutorService executorService)
```
    The ExecutorService this client should use for background polling threads. Optional configuration. If not set, then Executors.newFixedThreadPool(int) will be used with the number of threads equaling Runtime.availableProcessors().
    
    Returns:
    
    this.
  - jobPollInterval
```
public AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder jobPollInterval(long jobPollInterval)
```
    The time interval to use when polling the server for job updates. The unit of this time value can be specified via the jobPollIntervalTimeUnit(java.util.concurrent.TimeUnit) configuration. Optional configuration. If not set, then AdbGraphClientConfiguration.DEFAULT_JOB_POLL_INTERVAL will be used.
    
    Returns:
    
    this.
  - jobPollIntervalTimeUnit
```
public AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder jobPollIntervalTimeUnit(java.util.concurrent.TimeUnit jobPollIntervalTimeUnit)
```
    The time unit for the jobPollInterval(long) time value. Optional configuration. If not set, then AdbGraphClientConfiguration.DEFAULT_JOB_POLL_INTERVAL_TIME_UNIT will be used.
    
    Returns:
    
    this.
  - graphStudioApiVersion
```
public AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder graphStudioApiVersion(java.lang.String graphStudioApiVersion)
```
    The API version of the Graph Studio REST endpoints to use. Optional configuration. If not set, then AdbGraphClientConfiguration.DEFAULT_GRAPH_STUDIO_API_VERSION will be used.
    
    Returns:
    
    this.
  - dataStudioApiVersion
```
public AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder dataStudioApiVersion(java.lang.String dataStudioApiVersion)
```
    The API version of the Data Studio REST endpoints to use. Optional configuration. If not set, then AdbGraphClientConfiguration.DEFAULT_DATA_STUDIO_API_VERSION will be used.
    
    Returns:
    
    this.
  - brokerBaseUrl
```
public AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder brokerBaseUrl(java.lang.String brokerBaseUrl)
```
    Set the broker base URL to use. If not set, broker URL will be derived from AdbGraphClientConfiguration.getEndpoint(). URL is expected to end with '/broker/pdbcs'
    
    Returns:
    
    this.
  - pgxBaseUrl
```
public AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder pgxBaseUrl(java.lang.String pgxBaseUrl)
```
    Set the PGX base URL to use. If not set, PGX URL will be derived from AdbGraphClientConfiguration.getEndpoint(). URL is expected to end with '/graph/pgx'
    
    Returns:
    
    this.
  - graphStudioBaseUrl
```
public AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder graphStudioBaseUrl(java.lang.String graphStudioBaseUrl)
```
    Set the Graph Studio base URL to use. If not set, Graph Studio URL will be derived from AdbGraphClientConfiguration.getEndpoint(). URL is expected to end with '/graphstudio'
    
    Returns:
    
    this.
  - build
```
public AdbGraphClientConfiguration build()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class AdbGraphClientConfiguration.AdbGraphClientConfigurationBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

endpoint

database

username

password

tenancyOcid

databaseOcid

httpClient

refreshTimeBeforeTokenExpiry

refreshTimeBeforeTokenExpiryTimeUnit

executorService

jobPollInterval

jobPollIntervalTimeUnit

graphStudioApiVersion

dataStudioApiVersion

brokerBaseUrl

pgxBaseUrl

graphStudioBaseUrl

build

toString