io.pinecone.configs

Class PineconeConfig

java.lang.Object

io.pinecone.configs.PineconeConfig

public class PineconeConfig
extends java.lang.Object

The PineconeConfig class is responsible for managing the configuration settings required to interact with the Pinecone API. It provides methods to set and retrieve the necessary API key, host, source tag, proxyConfig, and custom managed channel.

     import io.grpc.ManagedChannel;
     import io.grpc.netty.GrpcSslContexts;
     import io.grpc.netty.NegotiationType;
     import io.grpc.netty.NettyChannelBuilder;
     import io.pinecone.configs.PineconeConfig;
     import io.pinecone.exceptions.PineconeException;

     import javax.net.ssl.SSLException;
     import java.util.concurrent.TimeUnit;
 ...


     PineconeConfig config = new PineconeConfig("apikey");
     String endpoint = "some-endpoint";
     NettyChannelBuilder builder = NettyChannelBuilder.forTarget(endpoint);

     // Custom channel with timeouts
     try {
         builder = builder.overrideAuthority(endpoint)
             .negotiationType(NegotiationType.TLS)
             .keepAliveTimeout(5, TimeUnit.SECONDS)
             .sslContext(GrpcSslContexts.forClient().build());
     } catch (SSLException e) {
         throw new PineconeException("SSL error opening gRPC channel", e);
     }

     // Build the managed channel with the configured options
     ManagedChannel channel = builder.build();
     config.setCustomManagedChannel(channel);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PineconeConfig.CustomChannelBuilder

Constructor Summary

Constructors

Constructor and Description
PineconeConfig(java.lang.String apiKey) Constructs a PineconeConfig instance with the specified API key.
PineconeConfig(java.lang.String apiKey, java.lang.String sourceTag) Constructs a PineconeConfig instance with the specified API key and source tag.
PineconeConfig(java.lang.String apiKey, java.lang.String sourceTag, ProxyConfig proxyConfig, okhttp3.OkHttpClient customOkHttpClient) Constructs a PineconeConfig instance with the specified API key, source tag, a HTTP proxy configuration, and a custom OkHttpClient.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApiKey() Returns the API key.
io.grpc.ManagedChannel	getCustomManagedChannel() Returns the custom gRPC managed channel.
okhttp3.OkHttpClient	getCustomOkHttpClient() Gets a custom OkHttpClient for making HTTP requests.
java.lang.String	getHost() Returns the host.
ProxyConfig	getProxyConfig() Returns the proxy configuration for control and data plane requests.
java.lang.String	getSourceTag() Returns the source tag.
java.lang.String	getUserAgent() Builds the user agent string for the Pinecone client.
boolean	isTLSEnabled() Returns true if TLS is enabled or false otherwise.
void	setApiKey(java.lang.String apiKey) Sets the API key.
void	setCustomManagedChannel(io.grpc.ManagedChannel customManagedChannel) Sets the custom gRPC managed channel if the user is not interested in using default gRPC channel initialized and set in the Pinecone Builder class.
void	setCustomOkHttpClient(okhttp3.OkHttpClient customOkHttpClient) Sets a custom OkHttpClient for making HTTP requests.
void	setHost(java.lang.String host) Sets the host.
void	setProxyConfig(ProxyConfig proxyConfig) Sets the proxy configuration for control and data plane requests.
void	setSourceTag(java.lang.String sourceTag) Sets the source tag.
void	setTLSEnabled(boolean enableTLS) Sets whether TLS is enabled.
void	validate() Validates the configuration settings of the Pinecone client.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PineconeConfig

public PineconeConfig(java.lang.String apiKey)

Constructs a PineconeConfig instance with the specified API key.

Parameters:

apiKey - The API key required to authenticate with the Pinecone API.

PineconeConfig

public PineconeConfig(java.lang.String apiKey,
                      java.lang.String sourceTag)

Constructs a PineconeConfig instance with the specified API key and source tag.

Parameters:

apiKey - The API key required to authenticate with the Pinecone API.

sourceTag - An optional source tag to be included in the user agent.

PineconeConfig

public PineconeConfig(java.lang.String apiKey,
                      java.lang.String sourceTag,
                      ProxyConfig proxyConfig,
                      okhttp3.OkHttpClient customOkHttpClient)

Constructs a PineconeConfig instance with the specified API key, source tag, a HTTP proxy configuration, and a custom OkHttpClient.

Parameters:

apiKey - The API key required to authenticate with the Pinecone API.

sourceTag - An optional source tag to be included in the user agent.

proxyConfig - The proxy configuration for control and data plane requests. Can be null if not set.

customOkHttpClient - The custom OkHttpClient for making HTTP requests. Can be null if not set.

Method Detail

getApiKey

public java.lang.String getApiKey()

Returns the API key.

Returns:

The API key.

setApiKey

public void setApiKey(java.lang.String apiKey)

Sets the API key.

Parameters:

apiKey - The new API key.

getHost

public java.lang.String getHost()

Returns the host.

Returns:

The host.

setHost

public void setHost(java.lang.String host)

Sets the host.

Parameters:

host - The new host.

getSourceTag

public java.lang.String getSourceTag()

Returns the source tag.

Returns:

The source tag.

setSourceTag

public void setSourceTag(java.lang.String sourceTag)

Sets the source tag. The source tag is normalized before being stored.

Parameters:

sourceTag - The new source tag.

getProxyConfig

public ProxyConfig getProxyConfig()

Returns the proxy configuration for control and data plane requests.

Returns:

The proxy configuration for control and data plane requests, or null if not set.

setProxyConfig

public void setProxyConfig(ProxyConfig proxyConfig)

Sets the proxy configuration for control and data plane requests.

Parameters:

proxyConfig - The new proxy configuration for control and data plane requests.

getCustomManagedChannel

public io.grpc.ManagedChannel getCustomManagedChannel()

Returns the custom gRPC managed channel.

Returns:

The custom gRPC managed channel.

getCustomOkHttpClient

public okhttp3.OkHttpClient getCustomOkHttpClient()

Gets a custom OkHttpClient for making HTTP requests.

Returns:

The custom OkHttpClient for control plane or inference api calls.

setCustomOkHttpClient

public void setCustomOkHttpClient(okhttp3.OkHttpClient customOkHttpClient)

Sets a custom OkHttpClient for making HTTP requests.

Parameters:

customOkHttpClient - The custom OkHttpClient.

setCustomManagedChannel

public void setCustomManagedChannel(io.grpc.ManagedChannel customManagedChannel)

Sets the custom gRPC managed channel if the user is not interested in using default gRPC channel initialized and set in the Pinecone Builder class.

Parameters:

customManagedChannel - The new custom gRPC managed channel.

validate

public void validate()

Validates the configuration settings of the Pinecone client. This method ensures that the API key is not null or empty, and validates the proxy configurations if set. Throws a PineconeConfigurationException if the API key is null or empty, or if any of the proxy configurations are invalid.

Throws:

PineconeConfigurationException - If the API key is null or empty, or if any of the proxy configurations are invalid.

getUserAgent

public java.lang.String getUserAgent()

Builds the user agent string for the Pinecone client.

Returns:

The user agent string.

isTLSEnabled

public boolean isTLSEnabled()

Returns true if TLS is enabled or false otherwise.

Returns:

enableTls

setTLSEnabled

public void setTLSEnabled(boolean enableTLS)

Sets whether TLS is enabled.

Parameters:

enableTLS - true to enable TLS, false to disable it.