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, 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.

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.
java.lang.String	getHost() Returns the host.
java.lang.String	getSourceTag() Returns the source tag.
java.lang.String	getUserAgent() Builds the user agent string for the Pinecone client.
java.lang.String	getUserAgentGrpc() Builds the user agent string for the Pinecone client's gRPC requests.
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	setHost(java.lang.String host) Sets the host.
void	setSourceTag(java.lang.String sourceTag) Sets the source tag.
void	validate() Validates the configuration, ensuring that the API key is not null or empty.

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.

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.

getCustomManagedChannel

public io.grpc.ManagedChannel getCustomManagedChannel()

Returns the custom gRPC managed channel.

Returns:

The custom gRPC managed channel.

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, ensuring that the API key is not null or empty.

Throws:

PineconeConfigurationException - if the API key is null or empty.

getUserAgent

public java.lang.String getUserAgent()

Builds the user agent string for the Pinecone client.

Returns:

The user agent string.

getUserAgentGrpc

public java.lang.String getUserAgentGrpc()

Builds the user agent string for the Pinecone client's gRPC requests.

Returns:

The user agent string for gRPC requests.